Skip to content

Latest commit

 

History

History
38 lines (28 loc) · 1.32 KB

README.md

File metadata and controls

38 lines (28 loc) · 1.32 KB

Python Project Template

This repository is intended to serve as a starting point for python projects. All dependencies are managed through the Poetry package manager, unit tests utilize the pytest framework, and the static analysis tools ruff and mypy installed by default.

Any derived projects should make use of VS Code with Docker Dev Containers.

Prerequisites

The following instructions assume that Docker, VSCode and Git are installed on the host computer. The VSCode extension Remote Development (ms-vscode-remote.vscode-remote-extensionpack) is required to open the project in a Dev Container.

Setting Up The Development Environment

  1. Clone the repository onto the host computer with the following command: 
     git clone https://github.com/hayesHowYaDoin/physics_backend.git
  2. Open the folder in VSCode. In the Command Palette (Ctrl+Shift+P), execute the command "Dev Containers: Open Folder In Container..."

And... that's it!

Commands

  • make install: Installs package dependencies.
  • make analyze: Runs static analysis.
  • make test: Runs unit tests.
  • make run: Executes the script.