Skip to main content

Redux-inspired library in python

Project description

pypi latest version pypi packge license dependencies status travis build status coverage status documentation status

A predictable state container for python heavily inspired by Redux

While not being a strict 1:1 port of Redux API, Revived is supposed to do pretty much the same job in the most pythonic way possible.

NOTE: I needed this piece of code to work with the latest python available at the moment (3.6). While I am not really caring about other versions, the Travis build is running the test suites on all the 3.5+ versions, including the dev ones.

Contents

Documentation

You can find the compiled documentation here:

Installation

Revived package is available on pypi: to install it use the following command:

pip install revived

Examples

Usage examples are coming soon.

Contribute

  1. Clone the repository.

  2. Create the virtualenv.

    • using virtualenv:

      virtualenv ENV
      bin/activate
    • using virtualfish:

      vf new ENV
      # optional: automatically load the virtualenv when entering the dir
      vf connect
  3. Update pip and install pip-tools:

    pip install --upgrade pip  # pip-tools needs pip==6.1 or higher (!)
    pip install pip-tools
  4. Install the dependencies:

    pip install -r requirements.txt
  5. Build the documentation:

    cd docs
    make html  # or whatever format you prefer
  6. Work on the revived module. This project uses pip-tools so you want to add your new direct dependencies in requirements.in and then compile the requirements.txt using:

    pip-compile requirements.in
  7. Write tests.

  8. Run tests:

    # to have coverage in command line
    pytest --cov revived --pep8 revived tests
    
    # to have html coverage file in the htmlcov directory
    pytest --cov revived --cov-report html --pep8 revived tests
  9. Check type hints:

    mypy revived tests
  10. Create a pull request.

  11. Profit :)

Changelog

0.1.3 - 2017-02-17

  • Integrate pip-tools: thanks to Lorenzo Villani for pointing me out to this solution

0.1.2 - 2017-02-16

  • Add documentation, tests and test coverage

0.1.1 - 2017-02-13

  • Add subscriber decorator in revived.store.Store

0.1.0 - 2017-02-12

  • Initial release

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

revived-0.1.4.tar.gz (10.4 kB view details)

Uploaded Source

Built Distribution

revived-0.1.4-py3-none-any.whl (12.0 kB view details)

Uploaded Python 3

File details

Details for the file revived-0.1.4.tar.gz.

File metadata

  • Download URL: revived-0.1.4.tar.gz
  • Upload date:
  • Size: 10.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for revived-0.1.4.tar.gz
Algorithm Hash digest
SHA256 610511a3dcc1d081f3c9f1875f0c3809fdee496431d226b9ef467a2cd701100e
MD5 bc2e13e6452eec1745ea153f1cdd5907
BLAKE2b-256 7d348600c4ab8c3e1cf2d25ebff918111a154ab49e3f78ec296a7f41e3842d2d

See more details on using hashes here.

File details

Details for the file revived-0.1.4-py3-none-any.whl.

File metadata

File hashes

Hashes for revived-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 6f48ae719d625f7abc208cfab628e5a5de91f65d772733af39417e5fe8cb3f3a
MD5 82dbe71125aba34e8aa639464804a579
BLAKE2b-256 65611a9c26bc5ca9fc1618876ec82e091392b27f185a6c2de54801218661a995

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page