Python Module Template (Cookiecutter)

This is a cookiecutter template for python module projects.

✨ Features

• Cookiecutter
• Python module/package
• Project Structure
• Boilerplate/Template
• Best Practices
• Configuration
• Test
• Build
• Documentation
• Scripts
• Examples
• CI/CD

---

🐤 Getting started

1. 🚧 Prerequisites

• Install Python (>= v3.10) and pip (>= 23):
  • [RECOMMENDED] Miniconda (v3)
  • [arm64/aarch64] Miniforge (v3)
  • [Python virtual environment] venv

For DEVELOPMENT environment:

• Install git
• Setup an SSH key

2. 📥 Download or clone the repository

# Create projects directory:
mkdir -pv ~/workspaces/projects
# Enter into projects directory:cd~/workspaces/projects
# Clone the repository:
git clone [REPOSITORY_URL]
# Or download and extract the repository from GitHub:# 1. Go to the repository on GitHub.# 2. Click on the "Code" button.# 3. Select "Download ZIP" and save the file to your computer.# 4. Extract the ZIP file in current directory.# Enter into the repository:cd module-python-template
# Change to cookiecutter branch:
git checkout cookiecutter

3. 📦 Install cookiecutter

# Install cookiecutter:
pip install -r ./requirements.txt
# Install pre-commit hooks:
pre-commit install

4. 🏗️ Generate project with cookiecutter

# Generate project:
cookiecutter -f .# Or:
./scripts/build.sh

5. 🏁 Start the project

cd [PROJECT_NAME]

👍

---

📑 References

• Cookiecutter (GitHub) - https://github.com/cookiecutter/cookiecutter
• Cookiecutter (Docs) - https://cookiecutter.readthedocs.io/en/stable