| Name | uvforge JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | None |
| Summary | A CLI tool to scaffold Python projects with uv |
| upload_time | 2025-08-19 11:36:05 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.13 |
| license | MIT License
Copyright (c) 2025 Manuel Rodríguez Sutil
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
|
| keywords |
cli
template
scaffold
python
uv
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 🐍 Py-Template
**Interactive Python project generator - like `create-react-app` but for Python**
Stop copying project structures and wrestling with configuration files. Answer a few questions, and get a perfectly structured Python project in seconds.
## ✨ Why py-template?
**Before py-template:**
```bash
mkdir my-project
cd my-project
touch setup.py pyproject.toml README.md requirements.txt .gitignore
mkdir src tests docs
# ... 15 more minutes of boilerplate setup
```
**With py-template:**
```bash
py-template
# Answer 4-5 quick questions
# ✅ Complete project ready in 30 seconds
```
### vs. cookiecutter
| Feature | py-template | cookiecutter |
| --------------- | ---------------------------- | ---------------------------- |
| Setup method | Interactive Q&A | Config files first |
| Learning curve | None - just answer questions | Need to understand JSON/YAML |
| Customization | Guided prompts | Pre-configure everything |
| User experience | Like create-react-app | Like filling out forms |
## ✨ Features
- **Interactive CLI** - Guided setup with friendly prompts
- **Fast Setup** - Uses `uv` for fast project initialization
- **Modern Structure** - Creates `src` layout following Python packaging best practices
- **Testing Ready** - Includes `pytest` setup with example tests
- **Docker Support** - Optional Dockerfile generation
- **MIT License** - Automatically generates license file
- **Development Tools** - Pre-configured with `ruff` for linting
## 📦 Installation
### Using pipx (Recommended)
```bash
pipx install git+https://github.com/manursutil/py-template.git
```
### Using uv (Development)
```bash
git clone https://github.com/manursutil/py-template.git
cd py-template
uv sync
uv pip install -e .
```
## 🚀 Usage
Simply run the command and follow the interactive prompts:
```bash
py-template
```
### Demo
### Generated Project Structure
```
my-awesome-app/
├── src/
│ └── my_awesome_app/
│ ├── __init__.py
│ └── main.py
├── tests/
│ ├── __init__.py
│ └── test_main.py
├── docs/
├── .github/
│ └── workflows/
│ └── ci.yml
├── LICENSE
├── README.md
├── .gitignore
├── pyproject.toml
└── Dockerfile + docker-compose.yml (optional)
```
## Development
See [CONTRIBUTING.md](/docs/contributing.md) for full details on setting up a dev environment, running tests, and contributing.
Quick start:
```bash
git clone https://github.com/manursutil/py-template.git
cd py-template
uv sync
uv run pytest
uv run ruff check .
uv run ruff format .
```
## A Note from the Author
Py-Template started as a tool I built for my own workflow so it is a very opinionated way to spin up Python projects with the tools I use most frequently.
That said, I’d love to make it useful for a broader audience.If you use a different stack, need extra integrations, or have ideas for improvement, please open an issue or PR.
Together we can make Py-Template a universal scaffolding tool for modern Python projects 🚀
See [CONTRIBUTING.md](/docs/contributing.md) for guidelines on how to get involved.
## 📝 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## 🙏 Acknowledgments
- Built with [uv](https://github.com/astral-sh/uv) for fast Python package management
- Uses [Rich](https://github.com/Textualize/rich) for beautiful terminal output
- Inspired by modern Python packaging practices
Raw data
{
"_id": null,
"home_page": null,
"name": "uvforge",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.13",
"maintainer_email": null,
"keywords": "cli, template, scaffold, python, uv",
"author": null,
"author_email": "Manuel Rodr\u00edguez Sutil <mrodsut@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/e4/96/a57c3da5e45965679fa690a077ef5ac9b4533abe989ae52b89d979b39197/uvforge-0.1.1.tar.gz",
"platform": null,
"description": "# \ud83d\udc0d Py-Template\n\n**Interactive Python project generator - like `create-react-app` but for Python**\n\nStop copying project structures and wrestling with configuration files. Answer a few questions, and get a perfectly structured Python project in seconds.\n\n## \u2728 Why py-template?\n\n**Before py-template:**\n\n```bash\nmkdir my-project\ncd my-project\ntouch setup.py pyproject.toml README.md requirements.txt .gitignore\nmkdir src tests docs\n# ... 15 more minutes of boilerplate setup\n```\n\n**With py-template:**\n\n```bash\npy-template\n# Answer 4-5 quick questions\n# \u2705 Complete project ready in 30 seconds\n```\n\n### vs. cookiecutter\n\n| Feature | py-template | cookiecutter |\n| --------------- | ---------------------------- | ---------------------------- |\n| Setup method | Interactive Q&A | Config files first |\n| Learning curve | None - just answer questions | Need to understand JSON/YAML |\n| Customization | Guided prompts | Pre-configure everything |\n| User experience | Like create-react-app | Like filling out forms |\n\n## \u2728 Features\n\n- **Interactive CLI** - Guided setup with friendly prompts\n- **Fast Setup** - Uses `uv` for fast project initialization\n- **Modern Structure** - Creates `src` layout following Python packaging best practices\n- **Testing Ready** - Includes `pytest` setup with example tests\n- **Docker Support** - Optional Dockerfile generation\n- **MIT License** - Automatically generates license file\n- **Development Tools** - Pre-configured with `ruff` for linting\n\n## \ud83d\udce6 Installation\n\n### Using pipx (Recommended)\n\n```bash\npipx install git+https://github.com/manursutil/py-template.git\n```\n\n### Using uv (Development)\n\n```bash\ngit clone https://github.com/manursutil/py-template.git\ncd py-template\nuv sync\nuv pip install -e .\n```\n\n## \ud83d\ude80 Usage\n\nSimply run the command and follow the interactive prompts:\n\n```bash\npy-template\n```\n\n### Demo\n\n\n\n### Generated Project Structure\n\n```\nmy-awesome-app/\n\u251c\u2500\u2500 src/\n\u2502 \u2514\u2500\u2500 my_awesome_app/\n\u2502 \u251c\u2500\u2500 __init__.py\n\u2502 \u2514\u2500\u2500 main.py\n\u251c\u2500\u2500 tests/\n\u2502 \u251c\u2500\u2500 __init__.py\n\u2502 \u2514\u2500\u2500 test_main.py\n\u251c\u2500\u2500 docs/\n\u251c\u2500\u2500 .github/\n\u2502 \u2514\u2500\u2500 workflows/\n\u2502 \u2514\u2500\u2500 ci.yml\n\u251c\u2500\u2500 LICENSE\n\u251c\u2500\u2500 README.md\n\u251c\u2500\u2500 .gitignore\n\u251c\u2500\u2500 pyproject.toml\n\u2514\u2500\u2500 Dockerfile + docker-compose.yml (optional)\n```\n\n## Development\n\nSee [CONTRIBUTING.md](/docs/contributing.md) for full details on setting up a dev environment, running tests, and contributing.\n\nQuick start:\n\n```bash\ngit clone https://github.com/manursutil/py-template.git\ncd py-template\nuv sync\n\nuv run pytest\nuv run ruff check .\nuv run ruff format .\n```\n\n## A Note from the Author\n\nPy-Template started as a tool I built for my own workflow so it is a very opinionated way to spin up Python projects with the tools I use most frequently.\n\nThat said, I\u2019d love to make it useful for a broader audience.If you use a different stack, need extra integrations, or have ideas for improvement, please open an issue or PR.\n\nTogether we can make Py-Template a universal scaffolding tool for modern Python projects \ud83d\ude80\n\nSee [CONTRIBUTING.md](/docs/contributing.md) for guidelines on how to get involved.\n\n## \ud83d\udcdd License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## \ud83d\ude4f Acknowledgments\n\n- Built with [uv](https://github.com/astral-sh/uv) for fast Python package management\n- Uses [Rich](https://github.com/Textualize/rich) for beautiful terminal output\n- Inspired by modern Python packaging practices\n",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) 2025 Manuel Rodr\u00edguez Sutil\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.\n ",
"summary": "A CLI tool to scaffold Python projects with uv",
"version": "0.1.1",
"project_urls": {
"Homepage": "https://github.com/manursutil/py-template",
"Issues": "https://github.com/manursutil/py-template/issues",
"Repository": "https://github.com/manursutil/py-template"
},
"split_keywords": [
"cli",
" template",
" scaffold",
" python",
" uv"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "ee3de2059542d89bd9666d9bc8841b65e4b825f469dd0fed099e886a56fa62a1",
"md5": "bf39e443c5b8683bbf9de43b17b10321",
"sha256": "09e084f93cf1c55c68f920e4744a8b67324e50f60e9b8e96d699ad2b670a2a65"
},
"downloads": -1,
"filename": "uvforge-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bf39e443c5b8683bbf9de43b17b10321",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.13",
"size": 11578,
"upload_time": "2025-08-19T11:36:04",
"upload_time_iso_8601": "2025-08-19T11:36:04.357196Z",
"url": "https://files.pythonhosted.org/packages/ee/3d/e2059542d89bd9666d9bc8841b65e4b825f469dd0fed099e886a56fa62a1/uvforge-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "e496a57c3da5e45965679fa690a077ef5ac9b4533abe989ae52b89d979b39197",
"md5": "60462a4f25a61441d94bab8519a2846d",
"sha256": "53da2dc9360a01ceb393c4f8eeaaf6ea3373b67daa454071b5006b249efc1301"
},
"downloads": -1,
"filename": "uvforge-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "60462a4f25a61441d94bab8519a2846d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.13",
"size": 14442,
"upload_time": "2025-08-19T11:36:05",
"upload_time_iso_8601": "2025-08-19T11:36:05.611895Z",
"url": "https://files.pythonhosted.org/packages/e4/96/a57c3da5e45965679fa690a077ef5ac9b4533abe989ae52b89d979b39197/uvforge-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-19 11:36:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "manursutil",
"github_project": "py-template",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "uvforge"
}
