Source code behind the development of the system architecture for our first electric car conversion. This code will allow us to connect our User Interface to our hardware interfaces such as CANBUS.
The code base is currently based off this architecture and data flow diagram.
Currently, the repo is using poetry Once that's setup and you've run
poetry install
run
pre-commit install
to configure the pre-commit scripts. It might be worth it to
pre-commit run --all-files
just to setup the pre-commit environment beforehand and make sure it doesn't bug out later.
demo can be run by just
python -m systems
or
poetry run python -m systems
If you're on VS Code, you should consider using the Python Docstring Generator extension on the Google docstring configuration. If you prefer other editors, please make sure your commits follow the current docstring convention.
Install pyenv-win to easily switch between Python versions. From pyenv, install python 3.9.1 and set it as the Python verion of the current repo.
Once pyenv is setup, install poetry, change directory in your terminal towards the project folder and run the following command
poetry shell
to run a virtual enviroment, then
poetry install
after that, run the following command to install pre-commit scripts
pre-commit install
finally, run the demo by just entering this command
python -m systems
or
poetry run python -m systems
Natively only supported on Linux and MacOS - use WSL 2 on Windows
- Clone this repository
git clone https://github.com/relectric-car-team/systems cdinto thesystemsfolder- Run
docker build .and copy the image name from the console as shown belowSuccessfully built <image name> - Then run the build
docker build <image name>
Please use semantic commit messages and branch naming conventions using this guide. Private branches should be named using the semantic/name/purpose convention. For example: docs/ratik/update-readme signifies that Ratik is responsible for this documentation change and the purpose of the branch is to update the README. Please base all pull requests off of the main branch as they will be rebase merged. The linear history requirement is enforced on main.
