Metadata-Version: 1.1
Name: bigcode-astgen
Version: 0.1.1
Summary: Tool to search and fetch code from GitHub
Home-page: https://github.com/tuvistavie/bigcode-tools/tree/master/bigcode-astgen/python
Author: Daniel Perez
Author-email: tuvistavie@gmail.com
License: UNKNOWN
Download-URL: https://github.com/tuvistavie/bigcode-tools/archive/master.zip
Description: # bigcode-astgen-py
        
        Generate Python files AST in a format compatible with [150k Python Dataset][1].
        
        The code is mostly copied from [150k Python Dataset][1] and adapted to work with Python 3.
        
        Note that this tool will only be able to parse the version of Python it is running,
        as it is internally using Python `ast` module, which uses the current Python parser.
        
        ## Install
        
        This tool can be installed by running
        
        ```
        pip install bigcode-astgen
        ```
        
        or by fetching this repository and running
        
        ```
        cd ast-generators/python
        pip install .
        ```
        
        ## CLI usage
        
        ```
        bigcode-astgen-py -f <files> -o <output>
        ```
        
        `<files>` should be a file, or a glob expression to files, and `output`
        should be a filename prefix in an existing directory where the result should be outputted.
        `output.txt` and `output.json` will be created.
        
        ### Example
        
        ```
        bigcode-astgen-py -f "src/**/*.py" -o result
        ```
        
        parse all `.py` files in `src` directory and output results in the `result` directory
        
        
        ## Python API
        
        ### `bigcode_astgen.ast_generator.parse_string`
        
        Returns the AST nodes of the given string
        
        Args:
        
        * `content`: string containing a Python program
        
        
        ### `bigcode_astgen.ast_generator.parse_file`
        
        Returns the AST nodes of the given file
        
        Args:
        
        * `filename`: path to a file containing a Python program
        
        ### `bigcode_astgen.ast_bulk_processor.process_files`
        
        Process all the files matched with the `files_pattern` and output the results in `output_dir`
        
        Args:
        
        * `files_pattern`: a glob pattern containing python files
        * `output`: the filename (without extension) where to output results
        
        ## License
        
        I could not find the license of [150k Python Dataset][1] source code from which
        `bigcode_astgen/ast_generator.py` is copied.
        Therefore, until further notice, this project does not follow the MIT license as the rest of the repository.
        
        
        [1]: http://www.srl.inf.ethz.ch/py150.php
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
