Metadata-Version: 2.1
Name: referencer
Version: 0.2.1
Summary: Generate a markfown reference from your public API docstrings and add it to your readme
Home-page: https://github.com/roll/referencer-py
Author: Evgeny Karev
Author-email: eskarev@gmail.com
License: MIT
Description: # referencer-py
        
        [![Travis](https://img.shields.io/travis/roll/referencer-py/master.svg)](https://travis-ci.org/roll/referencer-py)
        [![Coveralls](http://img.shields.io/coveralls/roll/referencer-py.svg?branch=master)](https://coveralls.io/r/roll/referencer-py?branch=master)
        [![PyPi](https://img.shields.io/pypi/v/referencer.svg)](https://pypi.python.org/pypi/referencer)
        [![Github](https://img.shields.io/badge/github-master-brightgreen)](https://github.com/roll/referencer-py)
        
        Generate a markdown reference from your public API docstrings and add it to your readme.
        
        ## Features
        
        - Uses `pydoc-markdown` under the hood
        
        ## Getting Started
        
        The package uses semantic versioning. It means that major versions  could include breaking changes.
        
        ```bash
        $ pip install referencer
        ```
        
        ## Documentation
        
        ```bash
        referencer package README.md --in-place
        ```
        
        ## API Reference
        
        ### `cli`
        ```python
        cli(package, document, **options)
        ```
        Command-line interface
        
        ```
        Usage: referencer [OPTIONS] PACKAGE DOCUMENT
        
        Options:
          --in-place               [default: False]
          --package-pattern TEXT   [default: from \.(\w+) import (\w+)]
          --document-section TEXT  [default: ## Reference]
          --version                Show the version and exit.
          --help                   Show this message and exit.
        ```
        
        
        ### `generate_document`
        ```python
        generate_document(package, document, package_pattern='from \\.(\\w+) import (\\w+)', document_section='## API Reference')
        ```
        Generate document
        
        ### `generate_reference`
        ```python
        generate_reference(package, package_pattern='from \\.(\\w+) import (\\w+)')
        ```
        Generate reference
        
        ## Contributing
        
        ```python
        virtualenv .python -ppython3.7
        source .python/bin/activate
        make install
        make test
        ```
        
        ## Changelog
        
        ### v0.1
        
        - Initial version
Keywords: docstring,markdown
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 :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Description-Content-Type: text/markdown
Provides-Extra: develop
