Package: devs
======pydevs======A Python wrapper of `adevs`_, a C++ library implementing the Discrete EventSystem Specification (DEVS)... _adevs: http://web.ornl.gov/~1qn/adevs/.. image:: https://readthedocs.org/projects/pydevs/badge/?version=latest:target: https://readthedocs.org/projects/pydevs/?badge=latest:alt: Documentation Status.. image:: http://img.shields.io/pypi/l/pydevs.svg:target: http://pydevs.readthedocs.org/en/latest/license.html:alt: License* **Documentation**: `pydevs.readthedocs.org <http://pydevs.readthedocs.org>`_* **Repository**: `github.com/andsor/pydevs <http://github.com/andsor/pydevs>`_* **Read the Docs**: `readthedocs.org/projects/pydevs <https://readthedocs.org/projects/pydevs>`_Requirements and Python 2/3 compatibility=========================================This package runs under **Python 2** and **Python 3**, and has been tested with**Python 2.7.6** and **Python 3.4.0**.License=======See the `LICENSE <LICENSE>`_ file.Developing==========Development environment-----------------------Use `tox`_ to `prepare virtual environments for development`_... _prepare virtual environments for development: http://testrun.org/tox/latest/example/devenv.html.. _tox: http://tox.testrun.orgTo set up a **Python 2.7** environment in ``.devenv27``, run::$ tox -e devenv27To set up a **Python 3.4** environment in ``.devenv34``, run::$ tox -e devenv34Packaging---------This package uses `setuptools`_... _setuptools: http://pythonhosted.org/setuptoolsRun ::$ python setup.py sdistor ::$ python setup.py bdistor ::$ python setup.py bdist_wheelto build a source, binary or wheel distribution.Complete Git Integration------------------------Setuptool uses the information of tags to infer the version of your projectwith the help of `versioneer <https://github.com/warner/python-versioneer>`_.To use this feature you need to tag with the format ``MAJOR.MINOR[.REVISION]``, e.g. ``v0.0.1`` or ``v0.1``.The prefix ``v`` is needed!Run ::$ python setup.py versionto retrieve the current `PEP440`_-compliant version.This version will be used when building a package and is also accessiblethrough ``devs.__version__``.The version will be ``unknown`` until you have added a first tag... _PEP440: http://www.python.org/dev/peps/pep-0440Pre-commit hooks................Unleash the power of Git by using its `pre-commit hooks<http://pre-commit.com/>`_.Run ::$ pre-commit installto install the pre-commit hooks.Sphinx Documentation--------------------Build the documentation with ::$ python setup.py docsand run doctests with ::$ python setup.py doctestAlternatively, let `tox`_`configure the virtual environment and run sphinx <http://tox.readthedocs.org/en/latest/example/general.html#integrating-sphinx-documentation-checks>`_::$ tox -e docsAdd further options separated from tox options by a double dash ``--``::$ tox -e docs -- --helpRead the Docs.............`Read the Docs`_ hosts the project athttps://readthedocs.org/projects/pydevs... _Read the Docs:  http://readthedocs.org/Add `requirements`_ for building the documentation to the`requirements-doc.txt <requirements-doc.txt>`_ file... _requirements: http://pip.readthedocs.org/en/latest/user_guide.html#requirements-filesContinuous documentation building---------------------------------For continuously building the documentation during development, run::$ python setup.py autodocsUnittest & Coverage-------------------Run ::$ python setup.py testto run all unittests defined in the subfolder ``tests`` with the help of `tox`_and `py.test`_... _py.test: http://pytest.orgThe py.test plugin `pytest-cov`_ is used to automatically generate a coveragereport... _pytest-cov: http://github.com/schlamar/pytest-covContinuous testing------------------For continuous testing in a **Python 2.7** environment, run::$ python setup.py test --tox-args='-c toxdev.ini -e py27'For continuous testing in a **Python 3.4** environment, run::$ python setup.py test --tox-args='-c toxdev.ini -e py34'Requirements Management-----------------------Add `requirements`_ to the `requirements.txt <requirements.txt>`_ file whichwill be automatically used by ``setup.py``.Add development `requirements`_ to the `requirements-dev.txt <requirements-dev.txt>`_ file.