py-snappy 0.1.0a1
py-snappy: A pure python implementation of the Snappy compression algorithm
License: MIT
Requires Python: >=3.6, <4
Keywords: ethereum

py-snappy
=========

|Join the chat at https://gitter.im/ethereum/py-snappy| |Build Status|
|PyPI version| |Python versions| |Docs build|

A pure python implementation of the Snappy compression algorithm

Read more in the `documentation on
ReadTheDocs <https://py-snappy.readthedocs.io/>`__. `View the change
log <https://py-snappy.readthedocs.io/en/latest/releases.html>`__.

Quickstart
----------

.. code:: sh

    pip install py-snappy

Developer Setup
---------------

If you would like to hack on py-snappy, please check out the `Ethereum
Development Tactical
Manual <https://github.com/pipermerriam/ethereum-dev-tactical-manual>`__
for information on how we do:

-  Testing
-  Pull Requests
-  Code Style
-  Documentation

Development Environment Setup
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can set up your dev environment with:

.. code:: sh

    git clone git@github.com:ethereum/py-snappy.git
    cd py-snappy
    virtualenv -p python3 venv
    . venv/bin/activate
    pip install -e .[dev]

Testing Setup
~~~~~~~~~~~~~

During development, you might like to have tests run on every file save.

Show flake8 errors on file change:

.. code:: sh

    # Test flake8
    when-changed -v -s -r -1 py_snappy/ tests/ -c "clear; flake8 py_snappy tests && echo 'flake8 success' || echo 'error'"

Run multi-process tests in one command, but without color:

.. code:: sh

    # in the project root:
    pytest --numprocesses=4 --looponfail --maxfail=1
    # the same thing, succinctly:
    pytest -n 4 -f --maxfail=1

Run in one thread, with color and desktop notifications:

.. code:: sh

    cd venv
    ptw --onfail "notify-send -t 5000 'Test failure ⚠⚠⚠⚠⚠' 'python 3 test on py-snappy failed'" ../tests ../py_snappy

Release setup
~~~~~~~~~~~~~

For Debian-like systems:

::

    apt install pandoc

To release a new version:

.. code:: sh

    make release bump=$$VERSION_PART_TO_BUMP$$

How to bumpversion
^^^^^^^^^^^^^^^^^^

The version format for this repo is ``{major}.{minor}.{patch}`` for
stable, and ``{major}.{minor}.{patch}-{stage}.{devnum}`` for unstable
(``stage`` can be alpha or beta).

To issue the next version in line, specify which part to bump, like
``make release bump=minor`` or ``make release bump=devnum``. This is
typically done from the master branch, except when releasing a beta (in
which case the beta is released from master, and the previous stable
branch is released from said branch). To include changes made with each
release, update "docs/releases.rst" with the changes, and apply commit
directly to master before release.

If you are in a beta version, ``make release bump=stage`` will switch to
a stable.

To issue an unstable version when the current version is stable, specify
the new version explicitly, like
``make release bump="--new-version 4.0.0-alpha.1 devnum"``

.. |Join the chat at https://gitter.im/ethereum/py-snappy| image:: https://badges.gitter.im/ethereum/py-snappy.svg
   :target: https://gitter.im/ethereum/py-snappy?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
.. |Build Status| image:: https://circleci.com/gh/ethereum/py-snappy.svg?style=shield
   :target: https://circleci.com/gh/ethereum/py-snappy
.. |PyPI version| image:: https://badge.fury.io/py/py-snappy.svg
   :target: https://badge.fury.io/py/py-snappy
.. |Python versions| image:: https://img.shields.io/pypi/pyversions/py-snappy.svg
   :target: https://pypi.python.org/pypi/py-snappy
.. |Docs build| image:: https://readthedocs.org/projects/py-snappy/badge/?version=latest
   :target: http://py-snappy.readthedocs.io/en/latest/?badge=latest