https://github.com/reity/capsules

Python library for encapsulating a function definition inside a temporary module file (mostly for use with multiprocessing and Jupyter Notebook).
https://github.com/reity/capsules

jupyter-notebook multiprocessing picklers pickling python-library

Last synced: about 2 months ago
JSON representation

Python library for encapsulating a function definition inside a temporary module file (mostly for use with multiprocessing and Jupyter Notebook).

• Host: GitHub
• URL: https://github.com/reity/capsules
• Owner: reity
• License: mit
• Created: 2020-08-28T02:52:15.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-12-20T04:11:00.000Z (about 4 years ago)
• Last Synced: 2024-11-14T09:43:44.907Z (about 2 months ago)
• Topics: jupyter-notebook, multiprocessing, picklers, pickling, python-library
• Language: Python
• Homepage: https://pypi.org/project/capsules
• Size: 16.6 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
========

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 `_ (see ``setup.cfg`` for configution details)::

    nosetests

Style conventions are enforced using `Pylint `_::

    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 `_.