jaws-libp 4.4.1

Jefferson Lab Alarm Warning System API

jaws-libp

Reusable Python Classes for JAWS.

---

• Install
• API
• Build
• Release
• See Also

---

Install

Requires Python 3.9+

pip install jaws-libp

Note: Using newer versions of Python may be problematic because the depenency confluent-kafka uses librdkafka, which often does not have a wheel file prepared for later versions of Python, meaning setuptools will attempt to compile it for you, and that often doesn't work (especially on Windows). Python 3.9 DOES have a wheel file for confluent-kafka so that's your safest bet.

API

Sphinx Docs

Build

This Python 3.9+ project is built with setuptools and may be run using the Python virtual environment feature to isolate dependencies. The pip tool can be used to download dependencies.

git clone https://github.com/JeffersonLab/jaws-libp
cd jaws-libp
python -m build

Note for JLab On-Site Users: Jefferson Lab has an intercepting proxy

See: Python Development Notes

Release

1. Bump the version number in setup.cfg and commit and push to GitHub (using Semantic Versioning).
2. Create a new release on the GitHub Releases page corresponding to same version in setup.cfg (Enumerate changes and link issues)
3. Clean build by removing build, dist, and docsrc/source/_autosummary directories
4. Activate virtual env
5. From venv build package, build docs, lint, test, and publish new artifact to PyPi with:

python -m build
sphinx-build -b html docsrc/source build/docs
pylint src/jaws_libp
pytest
python -m twine upload --repository pypi dist/*

4. Update Sphinx docs by copying them from build dir into gh-pages branch and updating index.html (commit, push).

See Also

• jaws-libj (Java)
• Developer Notes