Metadata-Version: 2.1
Name: capsules
Version: 0.1.0
Summary: Library for depositing a function definition inside a temporary module file.
Home-page: https://github.com/reity/capsules
Author: Andrei Lapets
Author-email: a@lapets.io
License: MIT
Description: ========
        capsules
        ========
        
        Python library for depositing a function definition inside a temporary module file (mostly for use with multiprocessing and Jupyter Notebook).
        
        |pypi| |travis| |coveralls|
        
        .. |pypi| image:: https://badge.fury.io/py/capsules.svg
           :target: https://badge.fury.io/py/capsules
           :alt: PyPI version and link.
        
        .. |travis| image:: https://travis-ci.com/reity/capsules.svg?branch=master
           :target: https://travis-ci.com/reity/capsules
        
        .. |coveralls| image:: https://coveralls.io/repos/github/reity/capsules/badge.svg?branch=master
           :target: https://coveralls.io/github/reity/capsules?branch=master
        
        Package Installation and Usage
        ------------------------------
        The package is available on PyPI::
        
            python -m pip install capsules
        
        The library can be imported in the usual ways::
        
            import capsules
            from capsules import capsules
        
        Adding the `capsules` decorator to a function definition will (1) automatically deposit that definition inside a temporary module file on disk, (2) import that module file, and (3) assign to the variable of the function being defined the function that was imported from that module::
        
            @capsules
            def double(x):
                return x + x
        
        Testing and Conventions
        -----------------------
        All unit tests are executed and their coverage is measured when using `nose <https://nose.readthedocs.io/>`_ (see ``setup.cfg`` for configution details)::
        
            nosetests
        
        Style conventions are enforced using `Pylint <https://www.pylint.org/>`_::
        
            pylint capsules
        
        Contributions
        -------------
        In order to contribute to the source code, open an issue or submit a pull request on the GitHub page for this library.
        
        Versioning
        ----------
        The version number format for this library and the changes to the library associated with version number increments conform with `Semantic Versioning 2.0.0 <https://semver.org/#semantic-versioning-200>`_.
        
Platform: UNKNOWN
Description-Content-Type: text/x-rst
