Metadata-Version: 2.1
Name: assumptions
Version: 1.1.0
Summary: Generating Markdown assumptions logs from code comments.
Home-page: UNKNOWN
Author: David Foster
Author-email: foster.dev999@gmail.com
License: MIT
Description: assumptions
        ===========
        
        .. image:: https://badge.fury.io/py/assumptions.svg
            :target: https://pypi.org/project/assumptions/
            :alt: PyPI release
        
        .. image:: https://github.com/foster999/assumptions/workflows/tests/badge.svg
            :target: https://github.com/foster999/assumptions/actions
            :alt: Actions build status
        
        .. image:: https://readthedocs.org/projects/assumptions/badge/?version=latest
            :target: https://assumptions.readthedocs.io/en/latest/?badge=latest
            :alt: Documentation Status
        
        See the `assumptions package documentation <https://assumptions.readthedocs.io>`_ for detailed usage and customisation.
        
        Installation and Usage
        ----------------------
        
        The Python package can be installed from PyPI:
        
        .. code-block:: sh
        
            pip install assumption
        
        
        Run the command line tool to generate help documentation:
        
        .. code-block:: sh
        
            assumptions -h
        
        By default, assumptions will recursively search the current directory for assumptions and caveats, before writing the log to the same directory.
        
        We recommend including assumptions in `pre-commit <https://pre-commit.com>`_ configurations:
        
        .. code-block:: yaml
        
            repos:
            -   repo: https://github.com/foster999/assumptions
                rev: 1.1.0
                hooks:
                -   id: assumptions
        
        This ensures that up-to-date logs are included in your project's version control.
        
        Alternatively, the command line tool can be called as part of continuous integration workflows.
        
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Text Processing
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
Provides-Extra: testing
Provides-Extra: docs
Provides-Extra: dev
