Contents

• Documentation

• Installation

• Examples

• Contribute

Documentation

You can find the compiled documentation here:

• http://revived.readthedocs.io

• http://revived.rtfd.io

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 :)

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