pytac 0.5.0

"Python Toolkit for Accelerator Controls"

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

Documentation is available at Readthedocs.

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.cfg 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/*