Developer’s Overview¶
Contributing¶
Contribute to source code, documentation, examples and report issues: https://github.com/hardbyte/python-can
There is also a python-can mailing list for development discussion.
Building & Installing¶
The following assumes that the commands are executed from the root of the repository:
- The project can be built and installed with
python setup.py build
andpython setup.py install
. - The unit tests can be run with
python setup.py test
. The tests can be run withpython2
,python3
,pypy
orpypy3
to test with other python versions, if they are installed. - The docs can be built with
sphinx-build doc/ doc/_build
.
Creating a Release¶
- Release from the
master
branch. - Update the library version in
__init__.py
using semantic versioning. - Run all tests and examples against available hardware.
- Update CONTRIBUTORS.txt with any new contributors.
- Sanity check that documentation has stayed inline with code. For large changes update
doc/history.rst
- Create a temporary virtual environment. Run
python setup.py install
andpython setup.py test
- Create and upload the distribution:
python setup.py sdist bdist_wheel
- Sign the packages with gpg
gpg --detach-sign -a dist/python_can-X.Y.Z-py3-none-any.whl
- Upload with twine
twine upload dist/python-can-X.Y.Z*
- In a new virtual env check that the package can be installed with pip:
pip install python-can==X.Y.Z
- Create a new tag in the repository.
- Check the release on PyPi, readthedocs and github.
Code Structure¶
The modules in python-can
are:
Module | Description |
---|---|
interfaces | Contains interface dependent code. |
bus | Contains the interface independent Bus object. |
CAN | Contains modules to emulate a CAN system, such as a time stamps, read/write streams and listeners. |
message | Contains the interface independent Message object. |
io | Contains a range of file readers and writers. |
broadcastmanager | Contains interface independent broadcast manager code. |