Project Template

A starting point for new Python projects.

Setup

Prerequisites

• Python 3.x installed.
• Git installed.
• uv package manager installed. Install it from https://docs.astral.sh/uv/getting-started/

Cloning the Template

First, clone this template repository to your local machine:

git clone <template_repository_url>
cd <your_project_name>

Installing Dependencies

Install the required packages using uv:

uv sync

This will create a virtual environment and install all dependencies from pyproject.toml.

Usage

Add your project-specific code in the src directory.

Running Code

Run Python scripts with:

uv run python <script.py>

Or run any command within the virtual environment:

uv run <command>

Configuration

Add any configuration files as needed (e.g., config.json, .env).

Testing

Run tests with:

uv run pytest

License

Specify your license here.