# Python project template byteorium
[](https://github.com/mab0189/python_project_template/actions/workflows/release.yml)
Python project template for building robust, modern, and clean Python projects according to my personal preferences.
Includes thorough code quality checks and developer-friendly tools.
---
## Table of contents
- [Features](#features)
- [Requirements](#requirements)
- [Setup](#setup)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
---
## Features
- **Dependency management**: Easy dependency management with `poetry`.
- **Code quality tools**:
- `ruff` for formatting, linting and coding standards.
- `pytest` for testing.
- `mypy` for typechecking.
- **Documentation**: Sphinx setup with RTD theme and `myst-parser` for Markdown support.
- **Easy usage**: Pre-configured `tox` workflow for a streamlined development experience.
- **Best Practices**: Adherence to PEP 8 and other modern Python standards.
---
## Requirements
Ensure you have the following installed:
- Python 3.12
- [Poetry](https://python-poetry.org/) is required for the dependency management
---
## Setup
Follow these steps to set up the project environment:
1. Clone the repository:
```bash
git clone https://github.com/mab0189/python_project_template_byteorium.git
cd python_project_template_byteorium
```
2. Set up a virtual environment with `poetry` with all dependencies:
```bash
poetry install
```
---
## Usage
[Tox](https://tox.readthedocs.io/) is used to manage and automate testing, linting, formatting, and more.
Below are the available environments configured in the `tox.ini`:
| Environment | Description | Command to Run |
|-----------------|-----------------------------------------------------------|------------------------|
| `py312` | Test code on Python 3.12 | `tox -e py312` |
| `isort` | Check and sort imports | `tox -e isort` |
| `format` | Auto-format code with `ruff` | `tox -e format` |
| `lint` | Lint code with `ruff` | `tox -e lint` |
| `typecheck` | Perform static type checking with `mypy` | `tox -e typecheck` |
| `test` | Run tests with `pytest` and `poetry` managed dependencies | `tox -e test` |
| `docs` | Build Sphinx HTML documentation | `tox -e docs` |
---
## Contributing
Contributions are welcome but this project is developed according to my personal preferences.
---
## License
This project is licensed under the [MIT License](LICENSE).
Raw data
{
"_id": null,
"home_page": "https://github.com/mab0189/python_project_template_byteorium",
"name": "my_package_byteorium",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "template, example",
"author": "mab0189",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/3c/78/80a724bb7d677c1e5d5589cbca02ee3180da93f5625f2b34afee7f00cafa/my_package_byteorium-0.1.5.tar.gz",
"platform": null,
"description": "# Python project template byteorium\n\n[](https://github.com/mab0189/python_project_template/actions/workflows/release.yml)\n\nPython project template for building robust, modern, and clean Python projects according to my personal preferences. \nIncludes thorough code quality checks and developer-friendly tools.\n\n---\n\n## Table of contents\n\n- [Features](#features)\n- [Requirements](#requirements)\n- [Setup](#setup)\n- [Usage](#usage)\n- [Contributing](#contributing)\n- [License](#license)\n\n---\n\n## Features\n\n- **Dependency management**: Easy dependency management with `poetry`.\n- **Code quality tools**: \n - `ruff` for formatting, linting and coding standards.\n - `pytest` for testing.\n - `mypy` for typechecking.\n- **Documentation**: Sphinx setup with RTD theme and `myst-parser` for Markdown support.\n- **Easy usage**: Pre-configured `tox` workflow for a streamlined development experience.\n- **Best Practices**: Adherence to PEP 8 and other modern Python standards.\n\n---\n\n## Requirements\n\nEnsure you have the following installed:\n\n- Python 3.12\n- [Poetry](https://python-poetry.org/) is required for the dependency management\n\n---\n\n## Setup\n\nFollow these steps to set up the project environment:\n\n1. Clone the repository:\n ```bash\n git clone https://github.com/mab0189/python_project_template_byteorium.git\n cd python_project_template_byteorium\n ```\n \n2. Set up a virtual environment with `poetry` with all dependencies:\n ```bash\n poetry install\n ```\n\n---\n\n## Usage\n\n[Tox](https://tox.readthedocs.io/) is used to manage and automate testing, linting, formatting, and more. \nBelow are the available environments configured in the `tox.ini`:\n\n| Environment | Description | Command to Run |\n|-----------------|-----------------------------------------------------------|------------------------|\n| `py312` | Test code on Python 3.12 | `tox -e py312` |\n| `isort` | Check and sort imports | `tox -e isort` |\n| `format` | Auto-format code with `ruff` | `tox -e format` | \n| `lint` | Lint code with `ruff` | `tox -e lint` |\n| `typecheck` | Perform static type checking with `mypy` | `tox -e typecheck` |\n| `test` | Run tests with `pytest` and `poetry` managed dependencies | `tox -e test` |\n| `docs` | Build Sphinx HTML documentation | `tox -e docs` |\n\n---\n\n## Contributing\n\nContributions are welcome but this project is developed according to my personal preferences.\n\n---\n\n## License\n\nThis project is licensed under the [MIT License](LICENSE).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python project template for building robust, modern, and clean Python projects.",
"version": "0.1.5",
"project_urls": {
"Homepage": "https://github.com/mab0189/python_project_template_byteorium",
"Repository": "https://github.com/mab0189/python_project_template_byteorium"
},
"split_keywords": [
"template",
" example"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e531969b3767b0fd55cf464d90f60010611c4f8ccd12fd1af7f7346de84b40ab",
"md5": "4ed7b8e758e6545f4ffb29b513ddc986",
"sha256": "f59038d6df6b111212b687a999236817c2cdcbf5b2a84e1ea40af4ba901b4f27"
},
"downloads": -1,
"filename": "my_package_byteorium-0.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4ed7b8e758e6545f4ffb29b513ddc986",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 4896,
"upload_time": "2025-08-03T14:59:18",
"upload_time_iso_8601": "2025-08-03T14:59:18.843684Z",
"url": "https://files.pythonhosted.org/packages/e5/31/969b3767b0fd55cf464d90f60010611c4f8ccd12fd1af7f7346de84b40ab/my_package_byteorium-0.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3c7880a724bb7d677c1e5d5589cbca02ee3180da93f5625f2b34afee7f00cafa",
"md5": "b0bdcc665db36aae32b1df729a3ad2d0",
"sha256": "89c31eee525bf84ce7fcb05f70f0ff208f5fd3bf26c0ddb0c0cb22ed11b5eab0"
},
"downloads": -1,
"filename": "my_package_byteorium-0.1.5.tar.gz",
"has_sig": false,
"md5_digest": "b0bdcc665db36aae32b1df729a3ad2d0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 3296,
"upload_time": "2025-08-03T14:59:20",
"upload_time_iso_8601": "2025-08-03T14:59:20.125558Z",
"url": "https://files.pythonhosted.org/packages/3c/78/80a724bb7d677c1e5d5589cbca02ee3180da93f5625f2b34afee7f00cafa/my_package_byteorium-0.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-03 14:59:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mab0189",
"github_project": "python_project_template_byteorium",
"github_not_found": true,
"lcname": "my_package_byteorium"
}
JSON
