Skip to content

Latest commit

 

History

History
145 lines (110 loc) · 2.95 KB

DEVELOPERS.md

File metadata and controls

145 lines (110 loc) · 2.95 KB

Developer Guide

Development Environment: Dev Container

This project comes with a development container (or dev container) setup, which allows for a reproducible development environment. To get started with the development, make sure you have the following software installed on your machine:

Next,

  1. Start Docker Desktop
  2. Clone repository
  3. Open repository with VS Code using the Open Folder option
  4. Click Reopen in Container when VS Code prompts you

Once the dev container is created, you are all set and ready to code!

Things To Try

The playbook.py file in the root directory provides a set of predefined commands. In the dev container, open a new terminal and run the following command to see what is available:

python playbook.py --help

Use the following command to run pre-commit and pytest with one command to make sure everything works as intended:

python playbook.py --check

Development Environment: Local Python Venv

To install a virtual Python environment locally, run the following commands from the root directory:

which python
python playbook.py --create-venv
source venv/onekit_on_windows/Scripts/activate  # Windows - Git Bash
source venv/onekit_on_linux/bin/activate  # Linux
poetry install --no-interaction; \
pre-commit install
python playbook.py --check

Useful Poetry commands

poetry check --lock
poetry lock --no-update
poetry add \
toolz \
pytz
poetry add --group precommit \
autoflake \
"black[jupyter]" \
isort \
"flake8>=5.0.4" \
pre-commit \
pre-commit-hooks
poetry add --group testing \
pytest \
pytest-cov \
pytest-skip-slow
poetry add --group docs \
furo \
jupyterlab \
myst-parser \
nbsphinx \
sphinx-autoapi \
sphinx-copybutton \
time-machine
poetry add --group packaging \
python-semantic-release
poetry add --group pandaskit \
"pandas>=0.23.2"
poetry add --group sklearnkit \
"scikit-learn>=1.3"
poetry add --group sparkkit \
pyspark==3.1.1
poetry add --group vizkit \
"matplotlib>=3.7.1"
poetry build
poetry publish

Git Commit Guidelines

This project applies semantic versioning with Python Semantic Release with the default Commit Message Format according to the Angular guidelines.