batlab 0.5.13

Low level library for communication with the Batlab V1.0 Battery Testing System by Lexcelon

batlab-software-python is a Python library and example command line script to interact with a pool of Batlabs over USB. This tool is designed for hobbyists and more advanced users who would like to incorporate the Batlab hardware in their own cell testing workflow or environment.

Requirements

Python >=3.4 is currently supported by this module.

Python >=2.7 is not yet supported.

Installation

To install the latest release you can use pip:

$ pip install batlab

To upgrade, you can run:

$ pip install batlab --upgrade or $ pip install batlab -U.

Documentation

Documentation for this library is hosted at Read the Docs.

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository.

Git branching model

We follow the development model described here. Anything in the master branch is considered production. Most work happens in the develop branch or in a feature branch that is merged into develop before being merged into master.

Documenting

Running tests

To run the unit tests, from the root directory run:

$ python setup.py test

Deployment

This library is deployed to PyPi. Builds are generated with Travis CI with each pushed commit. When a new tag is pushed or merged into master, that build is automatically deployed to end users through PyPi.

License

This library is licensed under LGPL-3.0 - see LICENSE for details.

Acknowledgements

Thank you to our backers on Kickstarter who made this project possible.

Documentation created with guide from Sam Nicholls.