Project README! Here we go!

Awesome driver-stalker project!

• Repository contents
• System requirements
• Other interesting info

Repository contents

• docs - documentation of the project
• reports - reports generated (as generated from notebooks)

  Check if you need to ignore large reports or keep them in Git LFS

• configs - configuration files directory
• notebooks - directory for jupyter notebooks
• scripts - repository service scripts

  These ones are not included into the pakckage if you build one - these scripts are only for usage with repository

• driver_stalker - source files of the project
• .editorconfig - configuration for editorconfig
• .gitignore - the files/folders git should ignore
• .pre-commit-config.yaml - pre-commit configuration file
• README.md - the one you read =)
• DEVELOPMENT.md - guide for development team
• Makefile - targets for make command
• cookiecutter-config-file.yml - cookiecutter project config log
• poetry.toml - poetry local config
• pyproject.toml - Python project configuration

System requirements

• Python version: 3.10
• Operating system: Ubuntu or WSL
• Poetry version >= 1.2.0

We tested on this setup - you can try other versions or operation systems by yourself!

Other interesting info

Here you can write anything about your project!