picklejar 3.1.0

Read and write pickles to a single file

Overview

picklejar is a python module that allows you to work with multiple pickles while reading/writing them to a single file/jar.

License

picklejar is released under the GNU Lesser General Public License v3.0, see the file LICENSE and LICENSE.lesser for the license text.

Compatibility

As of version 3.0.0, picklejar is compatible with the latest versions of Python3, and PyPy3!

Installation/Getting Started

The most straightforward way to get the picklejar module working for you is:

pip install picklejar

Documentation

All documentation for using picklejar can be found at ReadTheDocs

Contributing

Comments and enhancements are very welcome. To install picklejar for development purposes, first install Poetry and then run:

poetry install --with dev

Code contributions are encouraged: please feel free to fork the project and submit pull requests to the develop branch.

Report any issues or feature requests on the BitBucket bug tracker. Please include a minimal (not-) working example which reproduces the bug and, if appropriate, the traceback information. Please do not request features already being worked towards.

Building Documentation Locally

To install the packages required and build the Sphinx Documentation simply:

make docs

This will install all the requirements to work on picklejar and then build the HTML documentation. To open the docs in your default browser, simply run:

open docs/build/html/index.html

Testing

To run the tests for picklejar locally with your installed version of python, simply run:

make test

To run tests across different versions of Python via Docker, install and start Docker, then run:

make docker-test-all