mirror of
https://github.com/sprockets/sprockets.mixins.correlation.git
synced 2024-11-23 11:19:53 +00:00
280db40236
- Drop support for Python 2.7, 3.3, 3.4 as we no longer support these versions internally and nothing should be using them - Drop support for Tornado < 4.2 since this is also out of date - Add support for Tornado 5.1 and async with ``AsyncIOHandlerMixin`` - Update tests to include tests for the new ``AsyncIOHandlerMixin`` - Clean up code style a bit to make namespaces a bit more clear - Cleaup setup.py a minor bit and have it ignore ‘-r’ includes in requirements - Update PINs for requirements - Update LICENSE copyright dates
35 lines
1 KiB
ReStructuredText
35 lines
1 KiB
ReStructuredText
.. include:: ../README.rst
|
|
|
|
API Documentation
|
|
-----------------
|
|
|
|
correlation.HandlerMixin
|
|
~~~~~~~~~~~~~~~~~~~~~~~~
|
|
.. autoclass:: sprockets.mixins.correlation.HandlerMixin
|
|
:members:
|
|
|
|
.. autoclass:: sprockets.mixins.correlation.AsyncIOHandlerMixin
|
|
:members:
|
|
|
|
|
|
Contributing to this Library
|
|
----------------------------
|
|
|
|
The easiest way to start working with this code is to set up a virtual
|
|
environment and run ``env/bin/pip -r dev-requirements.txt``. That will
|
|
install the necessary testing tools. Then you can run everything else
|
|
using ``env/bin/python setup.py``:
|
|
|
|
- *setup.py nosetests* will run the tests using nose to test against the
|
|
and generate a coverage report to stdout.
|
|
|
|
- *setup.py build_sphinx* will generate HTML documentation into
|
|
*build/doc/html*. This is the doc set that is uploaded to Read The Docs.
|
|
|
|
- *setup.py flake8* will run the ``flake8`` utility and report on any
|
|
static code analysis failures.
|
|
|
|
This library follows the standard fork, modify, and pull request flow
|
|
for contributing.
|
|
|
|
.. include:: ../HISTORY.rst
|