Metadata-Version: 2.1
Name: pytac
Version: 0.3.0
Summary: Python Toolkit for Accelerator Controls (Pytac) is a Python library intended to make it easy to work with particle accelerators.
Home-page: https://github.com/dls-controls/pytac
Author: Will Rogers, Razvan Vasile, Tobyn Nicholls
Author-email: will.rogers@diamond.ac.uk
License: Apache License 2.0
Keywords: accelerator physics
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Requires-Dist: numpy
Requires-Dist: scipy
Provides-Extra: dev
Requires-Dist: check-manifest ; extra == 'dev'
Provides-Extra: test
Requires-Dist: coverage ; extra == 'test'

.. image:: https://travis-ci.org/dls-controls/pytac.png
   :target: https://travis-ci.org/dls-controls/pytac
.. image:: https://coveralls.io/repos/github/dls-controls/pytac/badge.svg?branch=master
   :target: https://coveralls.io/github/dls-controls/pytac?branch=master
.. image:: https://readthedocs.org/projects/pytac/badge/?version=latest
   :target: http://pytac.readthedocs.io/en/latest/?badge=latest
.. image:: https://badge.fury.io/py/pytac.svg
   :target: https://badge.fury.io/py/pytac
.. image:: https://img.shields.io/pypi/pyversions/pytac.svg
   :target: https://badge.fury.io/py/pytac


Python Toolkit for Accelerator Controls (Pytac) is a Python library for working
with elements of particle accelerators.

Documentation is available at Readthedocs_.

.. _ReadTheDocs: http://pytac.readthedocs.io

Testing
=======

It is simplest to work with pipenv::

 $ pipenv install --dev
 $ pipenv shell

To run the tests::

 $ python -m pytest

To see a coverage report, check pytest-cov::

 $ python -m pytest --cov-report term-missing --cov=pytac

To see style violations, use flake8::

 $ flake8

To build the documentation::

 $ cd docs
 $ sphinx-build -b html -E . _build/html

The documentation is built inside _build/html.

Uploading to Pypi
=================

Ensure that the version is correct in `setup.py` and then make a tag that
is the same as the version.

Create a source distribution::

 $ python setup.py sdist

Build a universal wheel::

 $ python setup.py bdist_wheel

Then upload it using twine::

 $ twine upload dist/*


