https://github.com/ryouze/py-template
Barebones Python project template (poetry + pytest).
https://github.com/ryouze/py-template
poetry-python pytest python python-template template unlicense
Last synced: about 2 months ago
JSON representation
Barebones Python project template (poetry + pytest).
- Host: GitHub
- URL: https://github.com/ryouze/py-template
- Owner: ryouze
- License: unlicense
- Created: 2024-11-06T18:31:16.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-03-10T17:03:13.000Z (about 2 months ago)
- Last Synced: 2025-03-10T17:31:40.194Z (about 2 months ago)
- Topics: poetry-python, pytest, python, python-template, template, unlicense
- Language: Python
- Homepage: https://ryouze.net/
- Size: 29.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
```
This is a barebones Python project template.
Features:
- Poetry for dependencies, pytest for testing.
- CI with GitHub Actions.
- Unlicense for unrestricted use.
You can find the sample README below. Feel free to modify it to suit your project.
Note: The MIT license is referenced, but this repo is actually under the Unlicense. I license most of my projects under MIT, so I put it in the template.
```
# py-template
[](https://github.com/ryouze/py-template/actions/workflows/ci.yml)
py-template is a barebones Python project template.
## Motivation
Text here.
## Features
- Written in modern Python (Python 3.12+).
- Comprehensive documentation with docstrings.
- Strict static typing.
## Tested Systems
This project has been tested on the following systems:
- macOS 15.3 (Sequoia)
Automated testing is also performed on the latest version of GNU/Linux (Python 3.12-3.13) using GitHub Actions.
## Requirements
To run this project, you'll need:
- Python 3.12 or higher
- [Poetry](https://python-poetry.org/) (optional for users, required for developers)
## Setup
Follow these steps to set up the project:
1. **Clone the repository**:
```sh
git clone https://github.com/ryouze/py-template.git
```
2. **Install the project**:
```sh
cd py-template
```
**Option 1: [Poetry](https://python-poetry.org/) (recommended)**:
```sh
poetry install --without dev
eval $(poetry env activate)
```
**Option 2: Pip in [editable mode](https://pip.pypa.io/en/stable/topics/local-project-installs/) (if you don't want to use 3rd-party build tools)**:
```sh
python3 -m venv .env
source .env/bin/activate
pip install -e .
```
Alternatively, the `generate_requirements.py` script can be used to generate `requirements.txt` for the traditional `pip install -r requirements.txt` method. Compatibility with this method is not guaranteed, as the project uses `poetry` for dependency management.
```sh
python3 generate_requirements.py
pip install -r requirements.txt
```
**Note:** All of the methods listed above install only production dependencies (i.e., for regular users). To install development dependencies as well, refer to the [Development and Testing](#development-and-testing) section.
## Usage
> [!IMPORTANT]
> You must activate the virtual environment (`eval $(poetry env activate)` or `source .env/bin/activate`) every time you open a new terminal. Most IDEs can activate the venv automatically (VSCode: `python.terminal.activateEnvInCurrentTerminal`).
To run the program, use the following command:
```sh
py-template
```
## Development and Testing
The `--without dev` flag in `poetry install` skips the installation of dev dependencies like `pytest`.
To install all dependencies (including development), use:
```sh
poetry install
```
To run tests manually, activate the virtual environment and run:
```sh
pytest -v
```
> [!NOTE]
> Installing the dev dependencies using pip is not supported due to syntax differences in the `pyproject.toml` file. However, if you insist on using pip, you can manually install the packages listed under `[tool.poetry.group.dev.dependencies]`.
## Credits
- [loguru](https://github.com/Delgan/loguru)
- [pytest](https://github.com/pytest-dev/pytest)
## Contributing
All contributions are welcome.
## License
This project is licensed under the MIT License.