https://github.com/kitswas/python-template
A minimal template for Python projects.
https://github.com/kitswas/python-template
machine-learning ml poetry-python python template uv
Last synced: 4 months ago
JSON representation
A minimal template for Python projects.
- Host: GitHub
- URL: https://github.com/kitswas/python-template
- Owner: kitswas
- License: unlicense
- Created: 2025-03-22T06:12:39.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-04-18T15:52:55.000Z (8 months ago)
- Last Synced: 2025-04-18T20:47:49.663Z (8 months ago)
- Topics: machine-learning, ml, poetry-python, python, template, uv
- Language: Python
- Homepage:
- Size: 34.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# python-template
A template for Python projects.
Includes basic project structure, a test suite, a code formatter and linter, and a dependency manager.
## How to use
You need the uv package/project manager to install the dependencies.
You can get [uv here](https://docs.astral.sh/uv/getting-started/installation/).
> [!NOTE]
> To change the Python version, change the `requires-python` field in [pyproject.toml](pyproject.toml)
> and the number in [.python-version](.python-version).
> uv will take care of the rest.
**Remember to replace the placeholders in the [pyproject.toml](pyproject.toml) file and change/remove the LICENSE file.**
Set up the environment. (Only once)
```bash
uv venv
# .venv/Scripts/activate # Windows
source .venv/bin/activate # Linux/MacOS
uv sync --link-mode=symlink # Install the dependencies, use -U to update
```
If you want Pytorch (with or without CUDA), you can install it using the `--extra` flag.
```bash
uv sync --link-mode=symlink --extra=torch-cpu # for CPU only
uv sync --link-mode=symlink --extra=torch-cu124 # for CUDA support
```
You can add other dependencies use `uv add`. The following example adds a valid kernel for Jupyter notebooks in VSCode.
```bash
uv add ipykernel # Similar to pip install ipykernel
```
To run any script, append `uv run` before the `python` command. (If the environment is inactive)
```bash
uv run python src/hello.py
```
Run tests:
```bash
uv run python -m unittest discover
```
Get rid of temporary files: (Use with caution)
```bash
git clean -fdX -n # Remove the -n flag to actually delete the files
```
## Code Formatting and Linting
We have [ruff](https://docs.astral.sh/ruff/) for code formatting and linting.
Install the [VSCode extension](https://marketplace.visualstudio.com/items?itemName=charliermarsh.ruff)
and enable `Format on Save` for a better experience.
To fix imports:
```bash
uv run ruff check --select I --fix # Sort imports
uv run ruff check --select F401 --fix # Remove unused imports
```
To check for linting errors:
```bash
uv run ruff check # Use --fix to fix the errors
```
To format the code:
```bash
uv run ruff format
```