Contributions and issues are most welcome! All issues and pull requests are handled through github on the dls_controls repository. Also, please check for any existing issues before filing a new one. If you have a great idea but it involves big changes, please file a ticket before making a pull request! We want to make sure you don't spend your time coding something that might not fit the scope of the project.
To get the source source code and run the unit tests, run:
$ git clone git://github.com/dls-controls/pymalcolm.git $ cd pymalcolm $ virtualenv --no-site-packages -p /path/to/python2.7 venv27 $ . venv27/bin/activate $ pip install 'pip>=9.0.1' $ pip install -r requirements/test.txt $ pytest tests
While 100% code coverage does not make a library bug-free, it significantly reduces the number of easily caught bugs! Please make sure coverage is at 100% before submitting a pull request!
Please arrange imports with the following style
# Standard library imports
import os
# Third party package imports
from mock import patch
# Local package imports
from malcolm.version import __version__Please follow Google's python style guide wherever possible.
When in the project directory:
$ pip install -r requirements/docs.txt $ python setup.py build_sphinx $ firefox docs/_build/html/index.html
Before a new release, please go through the following checklist:
- Bump version in malcolm/version.py
- Add a release note in CHANGELOG.rst
- Git tag the version
- Push to github and travis will make a release on pypi