Python Project Layout

From NovaOrdis Knowledge Base
Revision as of 00:44, 18 February 2022 by Ovidiu (talk | contribs) (→‎Overview)
Jump to navigation Jump to search

Internal

Overview

A typical Python project layout, which allows for code written in other programming languages as well, is similar to:

.
├─ .gitignore
├─ requirements.txt
├─ src
│   └─ main
│       └─ python 
│           └─ main.py
└─ venv # created automatically upon virtual environment initialization
     ├─ bin
    ...

Setting a Manual Project

Add the dependencies to requirements.txt. For more details, see:

requirements.txt

Initialize the virtual environment:

python3 -m venv venv
venv/bin/pip install -r requirements.txt

Example of .gitignore:

Example of requirements.txt:

datadog == 0.43.0

More details on requirements.txt

Virtual Environment

Organizatorium

  • /Users/ovidiu/Library/Python/3.8/bin/ must be in PATH.
  • Python environments on Mac:
    • ~/Library/ApplicationSupport/iTerm2/iterm2env/versions/*/bin/python3
    • ~/Library/ApplicationSupport/iTerm2/Scripts/YourScript/iterm2env/versions/*/bin/python3