Author: Ajinkya Kamat
Contact: [email protected]
This code has been tested on Macbook Pro
running Darwin 21.6.0
and Python 3.9.12
. The following steps are compatible with any unix-like system.
- Create a new python virtual environment using
venv
python3 -m venv .venv
- Activate the virtual environment
source .venv/bin/activate
- Install all dependencies
pip3 install -r requirements.txt
Python
: Easy to use; has a lot of library support; widely used in Roboticsvenv
: To ensure dependencies for this project don't interfere with other projects; Included inPython
by defaultpip
: Defacto package manager for pythonMarkdown
: Easy to use documentation language; Integrates well with documentation generators.
API documentation can be found here. Test coverage report can be found here