Metadata-Version: 2.1
Name: ebnf
Version: 0.1.0
Summary: A collection of ebnf tools
Home-page: https://github.com/MegaIng/ebnf
Author: MegaIng
Author-email: trampchamp@hotmail.com
License: UNKNOWN
Project-URL: Bug Reports, https://github.com/MegaIng/ebnf/issues
Project-URL: Source, https://github.com/MegaIng/ebnf
Description: # ebnf tools
        
        A collection of tools to work with ebnf grammars, like conversion between different formats, railroad generation and random example generation.
        
        ## Getting Started
        
        ### Prerequisites
        
        Requires python3.9 or higher.
        
        Other requirements like `lark` and `railroad-diagrams` should be installed automatically by pip
        
        ### Installing
        
        `pip install ebnf`
        
        If you want to use one of the extra utils with extra requirements, use the `ebnf[<extra>]` syntax:
        
        - **railroad** diagram generation:
        `pip install ebnf[railroad]`
          
        ## Tools
        
        The 'base' ebnf dialect for this package the one used by the `lark` package. All features should work for it, but might not work for others.
        
        
        ### `ebnf.railroad` - railroad diagram generation
        
        Generates a html file containing svg for each rule/terminal in the input grammar. Can take a lot of different options, check the help for more info
        
        ### `ebnf.convert` - dialect translation (TODO)
        
        Attempts to convert between different dialects, with the focus being generation `lark` compatible output
        
        ### `ebnf.example` - generates an example for a grammar (TODO)
        
        ## Versioning
        
        We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/MegaIng/ebnf/tags). 
        
        ## Authors
        
        * [MegaIng](https://github.com/MegaIng) - *Initial work*
        
        See also the list of [contributors](https://github.com/MegaIng/ebnf/contributors) who participated in this project.
        
        ## License
        
        This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
        
        
Keywords: ebnf,grammars,tools,railroad,lark
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: Topic :: Documentation
Classifier: Topic :: Utilities
Classifier: Topic :: Text Processing
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Typing :: Typed
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Provides-Extra: railroad
