51 lines (34 loc) · 1.21 KB

Minimal Python Template

A minimal, practical project template for small Python projects and experiments.

Requirements

Python 3.8+
uv

Usage

Using this Template

Fork or Copy: Fork this repository or copy the files to a new directory.
Rename Directory: Rename the directory to your desired project name.
Initialize Project: Run the following command to initialize the project with uv, which will generate a pyproject.toml based on your directory name:
```
uv init --lib --build-backend hatchling .
```
Note: If you want to specify a project name different from the directory name, you can pass the --name argument (if supported by your uv version) or simply rename the directory first.

Installation

Install dependencies:
```
uv sync
```

Running

Run the main script or module:
```
uv run -m your_package
```
Replace your_package with the actual package or script name.

Testing

Run tests using pytest:
```
uv run pytest
```

Contributing

Contributions are welcome. Open an issue or submit a pull request with a short description of changes.

License

MIT