| Name | uvi JSON |
| Version |
0.3.3
JSON |
| download |
| home_page | None |
| Summary | A python cookiecutter application to create a new python project that uses uv to manage its dependencies. |
| upload_time | 2025-01-03 13:13:06 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <4.0,>=3.10 |
| license | None |
| keywords |
cookiecutter
template
uv
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# `uvi` uv init
[](https://github.com/shaneholloman/uvi/actions/workflows/main.yml?query=branch%3Amain)
[](https://github.com/shaneholloman/uvi/blob/main/pyproject.toml)
[](https://shaneholloman.github.io/uvi/)
[](https://img.shields.io/github/license/shaneholloman/uvi)
This is a modern Cookiecutter template that can be used to initiate a Python project with all the necessary tools for development, testing, and deployment. It supports the following features:
> This project 'works' but is far from perfect!
See todos: [TODO.md](./TODO.md)
- [uv](https://docs.astral.sh/uv/) for dependency management
- CI/CD with [GitHub Actions](https://github.com/features/actions)
- Pre-commit hooks with [pre-commit](https://pre-commit.com/)
- Code quality with [ruff](https://github.com/charliermarsh/ruff), [mypy](https://mypy.readthedocs.io/en/stable/), [deptry](https://github.com/shaneholloman/deptry/) and [prettier](https://prettier.io/)
- Publishing to [PyPI](https://pypi.org) by creating a new release on GitHub
- Testing and coverage with [pytest](https://docs.pytest.org/en/7.1.x/) and [codecov](https://about.codecov.io/)
- Documentation with [MkDocs](https://www.mkdocs.org/)
- Compatibility testing for multiple versions of Python with [tox-uv](https://github.com/tox-dev/tox-uv)
- Containerization with [Docker](https://www.docker.com/)
- Development environment with [VSCode devcontainers](https://code.visualstudio.com/docs/devcontainers/containers)
## Docs
- [Docs](https://shaneholloman.github.io/uvi/)
## Installation & Usage
> For both methods follow the prompts to configure your project. Once completed, a new directory containing your project will be created. Then navigate into your newly created project directory and follow the instructions in the `README.md` to complete the setup of your project.
### Method 1: Using the CLI tool (Recommended)
Install the `uvi` tool globally:
```bash
uv tool install uvi
```
```bash
# or using pip
pip install uvi
```
Then navigate to the directory where you want to create your project and run:
```bash
uvi
```
### Method 2: Using Cookiecutter directly
Alternatively, you can use cookiecutter directly:
```bash
uvx cookiecutter https://github.com/shaneholloman/uvi.git
# or if you don't have uv installed:
pip install cookiecutter
cookiecutter https://github.com/shaneholloman/uvi.git
```
Raw data
{
"_id": null,
"home_page": null,
"name": "uvi",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": "cookiecutter, template, uv",
"author": null,
"author_email": "Shane Holloman <shaneholloman@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/4f/a8/7214baed2315275f20b30d4c3f5a76c13ac96245289536faf9355b0061f0/uvi-0.3.3.tar.gz",
"platform": null,
"description": "# `uvi` uv init\r\n\r\n[](https://github.com/shaneholloman/uvi/actions/workflows/main.yml?query=branch%3Amain)\r\n[](https://github.com/shaneholloman/uvi/blob/main/pyproject.toml)\r\n[](https://shaneholloman.github.io/uvi/)\r\n[](https://img.shields.io/github/license/shaneholloman/uvi)\r\n\r\nThis is a modern Cookiecutter template that can be used to initiate a Python project with all the necessary tools for development, testing, and deployment. It supports the following features:\r\n\r\n> This project 'works' but is far from perfect!\r\n\r\nSee todos: [TODO.md](./TODO.md)\r\n\r\n- [uv](https://docs.astral.sh/uv/) for dependency management\r\n- CI/CD with [GitHub Actions](https://github.com/features/actions)\r\n- Pre-commit hooks with [pre-commit](https://pre-commit.com/)\r\n- Code quality with [ruff](https://github.com/charliermarsh/ruff), [mypy](https://mypy.readthedocs.io/en/stable/), [deptry](https://github.com/shaneholloman/deptry/) and [prettier](https://prettier.io/)\r\n- Publishing to [PyPI](https://pypi.org) by creating a new release on GitHub\r\n- Testing and coverage with [pytest](https://docs.pytest.org/en/7.1.x/) and [codecov](https://about.codecov.io/)\r\n- Documentation with [MkDocs](https://www.mkdocs.org/)\r\n- Compatibility testing for multiple versions of Python with [tox-uv](https://github.com/tox-dev/tox-uv)\r\n- Containerization with [Docker](https://www.docker.com/)\r\n- Development environment with [VSCode devcontainers](https://code.visualstudio.com/docs/devcontainers/containers)\r\n\r\n## Docs\r\n\r\n- [Docs](https://shaneholloman.github.io/uvi/)\r\n\r\n## Installation & Usage\r\n\r\n> For both methods follow the prompts to configure your project. Once completed, a new directory containing your project will be created. Then navigate into your newly created project directory and follow the instructions in the `README.md` to complete the setup of your project.\r\n\r\n### Method 1: Using the CLI tool (Recommended)\r\n\r\nInstall the `uvi` tool globally:\r\n\r\n```bash\r\nuv tool install uvi\r\n```\r\n\r\n```bash\r\n# or using pip\r\npip install uvi\r\n```\r\n\r\nThen navigate to the directory where you want to create your project and run:\r\n\r\n```bash\r\nuvi\r\n```\r\n\r\n### Method 2: Using Cookiecutter directly\r\n\r\nAlternatively, you can use cookiecutter directly:\r\n\r\n```bash\r\nuvx cookiecutter https://github.com/shaneholloman/uvi.git\r\n# or if you don't have uv installed:\r\npip install cookiecutter\r\ncookiecutter https://github.com/shaneholloman/uvi.git\r\n```\r\n",
"bugtrack_url": null,
"license": null,
"summary": "A python cookiecutter application to create a new python project that uses uv to manage its dependencies.",
"version": "0.3.3",
"project_urls": {
"Documentation": "https://shaneholloman.github.io/uvi/",
"Homepage": "https://shaneholloman.github.io/uvi/",
"Repository": "https://github.com/shaneholloman/uvi"
},
"split_keywords": [
"cookiecutter",
" template",
" uv"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7ad3c139ee3d2901a4a9baedb6a9669c0c13db8e56a244f70e713effb26149e4",
"md5": "37ac2e1d09dbcf508ad22f2bd73ff02b",
"sha256": "01497f80213ec66dd2a3c96ab127dd274fa67744bff1f57038a301bdf2138be0"
},
"downloads": -1,
"filename": "uvi-0.3.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "37ac2e1d09dbcf508ad22f2bd73ff02b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 5020,
"upload_time": "2025-01-03T13:13:03",
"upload_time_iso_8601": "2025-01-03T13:13:03.875543Z",
"url": "https://files.pythonhosted.org/packages/7a/d3/c139ee3d2901a4a9baedb6a9669c0c13db8e56a244f70e713effb26149e4/uvi-0.3.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4fa87214baed2315275f20b30d4c3f5a76c13ac96245289536faf9355b0061f0",
"md5": "b0b2f41fb6360ffc2b798a8f12d1b4fc",
"sha256": "e295af0aad623b819316e57ceb25dadf64e302fc89d45675af3a3d07dc8a922f"
},
"downloads": -1,
"filename": "uvi-0.3.3.tar.gz",
"has_sig": false,
"md5_digest": "b0b2f41fb6360ffc2b798a8f12d1b4fc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 36352,
"upload_time": "2025-01-03T13:13:06",
"upload_time_iso_8601": "2025-01-03T13:13:06.331979Z",
"url": "https://files.pythonhosted.org/packages/4f/a8/7214baed2315275f20b30d4c3f5a76c13ac96245289536faf9355b0061f0/uvi-0.3.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-03 13:13:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "shaneholloman",
"github_project": "uvi",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "uvi"
}
