pytemplate-uv 0.1.0__tar.gz

pytemplate_uv-0.1.0/.gitignore

@@ -0,0 +1,82 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# Virtual Environments
+.env
+.venv
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# IDEs and Editors
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+
+# OS Generated Files
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+
+# Testing and Coverage
+.tox/
+.coverage
+.coverage.*
+.cache
+.pytest_cache/
+htmlcov/
+coverage.xml
+*.cover
+.hypothesis/
+
+# Logs
+*.log
+logs/
+
+# UV Package Manager
+uv.lock
+
+# Jupyter Notebooks
+.ipynb_checkpoints
+
+# Mypy
+.mypy_cache/
+
+# Compiled files
+*.pyc
+*.pyo
+*.pyd
+
+# Project Specific Ignores
+*.sqlite3
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local

pytemplate_uv-0.1.0/.python-version

@@ -0,0 +1 @@
+3.11

pytemplate_uv-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Leo Liu
+
+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.

pytemplate_uv-0.1.0/PKG-INFO

@@ -0,0 +1,142 @@
+Metadata-Version: 2.2
+Name: pytemplate-uv
+Version: 0.1.0
+Summary: A template for creating Python projects using uv package manager
+Author-email: Leo Liu <yuxuzi@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/yuxuzi/pytemplate-uv
+Project-URL: Repository, https://github.com/yuxuzi/pytemplate-uv
+Project-URL: Issues, https://github.com/yuxuzi/pytemplate-uv/issues
+Project-URL: Changelog, https://github.com/yuxuzi/pytemplate-uv/blob/main/CHANGELOG.md
+Keywords: python,template,project-generator,uv,cookiecutter,cli
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Utilities
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: typer>=0.9.0
+Requires-Dist: rich>=13.7.0
+Requires-Dist: cookiecutter>=2.5.0
+Requires-Dist: pytest>=7.4.4
+Provides-Extra: dev
+Requires-Dist: ruff>=0.1.9; extra == "dev"
+Requires-Dist: black>=23.12.1; extra == "dev"
+Requires-Dist: pytest>=7.4.4; extra == "dev"
+Requires-Dist: pre-commit>=3.6.0; extra == "dev"
+Requires-Dist: mypy>=1.7.1; extra == "dev"
+Requires-Dist: coverage>=7.3.2; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: mkdocs>=1.5.3; extra == "docs"
+Requires-Dist: mkdocstrings[python]>=0.24.0; extra == "docs"
+
+# PyTemplate UV
+
+## Overview
+
+PyTemplate UV is a powerful CLI tool for creating Python project templates using the `uv` package manager. It provides a seamless way to generate standardized project structures with modern development practices.
+
+## Features
+
+- 🚀 Quick project initialization
+- 🔧 Support for multiple project templates (FastAPI, Standard Python)
+- 📦 Integrated with `uv` package management
+- 🧪 Comprehensive testing infrastructure
+- 🔍 Linting and type checking support
+
+## Prerequisites
+
+- Python 3.11+
+- `uv` package manager
+- `cookiecutter`
+
+## Installation
+
+```bash
+pip install pytemplate-uv
+# or
+uv pip install pytemplate-uv
+```
+
+## Usage
+
+### Create a Project
+
+```bash
+# Create a standard Python project (default)
+pytemplate-uv create-project
+
+# Create a FastAPI project
+pytemplate-uv create-project --template fastapi
+
+# Create a project with a custom name
+pytemplate-uv create-project --name my-awesome-project
+
+# Create a project with custom template and name
+pytemplate-uv create-project --template fastapi --name my-api-project
+```
+
+### Project Creation Options
+
+- `--template`: Choose the project template (default: pyproject)
+  - Options: `pyproject`, `fastapi`
+- `--name`: Specify a custom project name
+- Additional template-specific options can be passed as needed
+
+### Next Steps After Project Creation
+
+1. `cd` into your project directory
+2. Run `uv venv` to create a virtual environment
+3. Run `uv pip install -e .` to install dependencies
+4. Run `make setup` to set up the development environment
+
+## Development
+
+### Setup
+
+1. Clone the repository
+2. Create a virtual environment:
+   ```bash
+   uv venv
+   source .venv/bin/activate
+   ```
+
+3. Install development dependencies:
+   ```bash
+   uv pip install -e .[dev]
+   ```
+
+### Running Tests
+
+```bash
+pytest
+```
+
+### Linting
+
+```bash
+ruff check .
+black .
+mypy .
+```
+
+## Contributing
+
+Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details.
+
+## License
+
+MIT License - See [LICENSE](LICENSE) for details.
+
+## Contact
+
+Leo Liu - [GitHub](https://github.com/yuxuzi)
+
+---
+
+*Simplifying Python project creation with modern best practices* 🐍✨

pytemplate_uv-0.1.0/README.md

@@ -0,0 +1,105 @@
+# PyTemplate UV
+
+## Overview
+
+PyTemplate UV is a powerful CLI tool for creating Python project templates using the `uv` package manager. It provides a seamless way to generate standardized project structures with modern development practices.
+
+## Features
+
+- 🚀 Quick project initialization
+- 🔧 Support for multiple project templates (FastAPI, Standard Python)
+- 📦 Integrated with `uv` package management
+- 🧪 Comprehensive testing infrastructure
+- 🔍 Linting and type checking support
+
+## Prerequisites
+
+- Python 3.11+
+- `uv` package manager
+- `cookiecutter`
+
+## Installation
+
+```bash
+pip install pytemplate-uv
+# or
+uv pip install pytemplate-uv
+```
+
+## Usage
+
+### Create a Project
+
+```bash
+# Create a standard Python project (default)
+pytemplate-uv create-project
+
+# Create a FastAPI project
+pytemplate-uv create-project --template fastapi
+
+# Create a project with a custom name
+pytemplate-uv create-project --name my-awesome-project
+
+# Create a project with custom template and name
+pytemplate-uv create-project --template fastapi --name my-api-project
+```
+
+### Project Creation Options
+
+- `--template`: Choose the project template (default: pyproject)
+  - Options: `pyproject`, `fastapi`
+- `--name`: Specify a custom project name
+- Additional template-specific options can be passed as needed
+
+### Next Steps After Project Creation
+
+1. `cd` into your project directory
+2. Run `uv venv` to create a virtual environment
+3. Run `uv pip install -e .` to install dependencies
+4. Run `make setup` to set up the development environment
+
+## Development
+
+### Setup
+
+1. Clone the repository
+2. Create a virtual environment:
+   ```bash
+   uv venv
+   source .venv/bin/activate
+   ```
+
+3. Install development dependencies:
+   ```bash
+   uv pip install -e .[dev]
+   ```
+
+### Running Tests
+
+```bash
+pytest
+```
+
+### Linting
+
+```bash
+ruff check .
+black .
+mypy .
+```
+
+## Contributing
+
+Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details.
+
+## License
+
+MIT License - See [LICENSE](LICENSE) for details.
+
+## Contact
+
+Leo Liu - [GitHub](https://github.com/yuxuzi)
+
+---
+
+*Simplifying Python project creation with modern best practices* 🐍✨

pytemplate_uv-0.1.0/pyproject.toml

@@ -0,0 +1,103 @@
+[build-system]
+requires = ["setuptools>=68.2.0", "wheel", "setuptools_scm[toml]>=7.1.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pytemplate-uv"
+version = "0.1.0"
+description = "A template for creating Python projects using uv package manager"
+readme = "README.md"
+requires-python = ">=3.11"
+license = {text = "MIT"}
+authors = [
+    {name = "Leo Liu", email = "yuxuzi@gmail.com"}
+]
+keywords = [
+    "python", 
+    "template", 
+    "project-generator", 
+    "uv", 
+    "cookiecutter", 
+    "cli"
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Utilities",
+    "Typing :: Typed"
+]
+
+dependencies = [
+    "typer>=0.9.0",
+    "rich>=13.7.0",
+    "cookiecutter>=2.5.0",
+    "pytest>=7.4.4"
+]
+
+[project.urls]
+Homepage = "https://github.com/yuxuzi/pytemplate-uv"
+Repository = "https://github.com/yuxuzi/pytemplate-uv"
+Issues = "https://github.com/yuxuzi/pytemplate-uv/issues"
+Changelog = "https://github.com/yuxuzi/pytemplate-uv/blob/main/CHANGELOG.md"
+
+[project.optional-dependencies]
+dev = [
+    "ruff>=0.1.9",
+    "black>=23.12.1",
+    "pytest>=7.4.4",
+    "pre-commit>=3.6.0",
+    "mypy>=1.7.1",
+    "coverage>=7.3.2"
+]
+docs = [
+    "mkdocs>=1.5.3",
+    "mkdocstrings[python]>=0.24.0"
+]
+
+[tool.setuptools]
+packages = ["pytemplate"]
+
+[project.scripts]
+# Project management scripts
+pytemplate = "pytemplate.main:app"
+create-project = "pytemplate.main:app"
+
+[tool.setuptools.package-data]
+"pytemplate" = ["../templates/*", "../templates/**/*", "../templates/**/**/*"]
+
+[tool.setuptools_scm]
+write_to = "version.py"
+
+[tool.ruff]
+line-length = 100
+target-version = "py311"
+select = [
+    "E",    # pycodestyle errors
+    "W",    # pycodestyle warnings
+    "F",    # pyflakes
+    "I",    # isort
+    "B",    # flake8-bugbear
+    "UP",   # pyupgrade
+    "C90",  # mccabe complexity
+    "N",    # pep8-naming
+    "D",    # pydocstyle
+]
+ignore = [
+    "D100",  # Missing docstring in public module
+    "D101",  # Missing docstring in public class
+]
+
+[tool.ruff.per-file-ignores]
+"tests/**" = ["D103"]  # Ignore missing docstrings in tests
+
+[tool.black]
+line-length = 100
+target-version = ['py311']
+
+[tool.mypy]
+python_version = "3.11"
+warn_return_any = true

pytemplate_uv-0.1.0/pytemplate/__init__.py

@@ -0,0 +1 @@
+# Pytemplate package initialization

pytemplate_uv-0.1.0/pytemplate/main.py

@@ -0,0 +1,142 @@
+"""Command-line interface for creating Python projects from templates."""
+
+from __future__ import annotations
+
+import os
+import subprocess
+from pathlib import Path
+
+import typer
+from rich.console import Console
+from rich.panel import Panel
+from rich.text import Text
+
+app = typer.Typer(
+    name="pytemplate-uv",
+    help="Create Python projects from templates using uv package manager",
+    add_completion=True,
+    rich_help_panel=True,
+)
+console = Console()
+
+
+def _validate_template(template: str) -> Path:
+    """Validate and return the path to the specified template.
+
+    Args:
+        template (str): Name of the project template.
+
+    Returns:
+        Path: Path to the template directory.
+
+    Raises:
+        typer.BadParameter: If template is not found.
+
+    """
+    templates_dir = Path(__file__).parent.parent / "templates"
+    template_path = templates_dir / f"{template}-template"
+
+    console.print(f"[yellow]Checking template path: {template_path}[/]")
+
+    if not template_path.exists():
+        available_templates = [
+            d.name.replace("-template", "") for d in templates_dir.glob("*-template") if d.is_dir()
+        ]
+
+        error_text = Text("Template not found!", style="bold red")
+        suggestion_text = Text(
+            f"\nAvailable templates: {', '.join(available_templates)}", style="yellow"
+        )
+
+        console.print(Panel(Text.assemble(error_text, suggestion_text), border_style="red"))
+        raise typer.BadParameter(f"Template '{template}' not found")
+
+    console.print(f"[green]Using template path: {template_path}[/]")
+    return template_path
+
+
+def _get_context() -> dict[str, str]:
+    """Retrieve context variables for project template.
+
+    Returns:
+        A dictionary of context variables.
+
+    """
+    return {
+        "author": os.environ.get("USER", "your name"),
+        "email": os.environ.get("USER_EMAIL", "your@email.com"),
+        "github_username": os.environ.get("GITHUB_USERNAME", "your_username"),
+    }
+
+
+def _build_cookiecutter_command(
+    template_path: Path, context: dict, no_input: bool = False, force: bool = False
+) -> list[str]:
+    """Build the cookiecutter command with appropriate options.
+    Args:
+        template_path: Path to the project template
+        context: Context variables for the template
+        no_input: Whether to skip interactive prompts
+        force: Whether to overwrite existing project directory
+    Returns:
+        A list of command arguments.
+
+    """  # noqa: D205, D411
+    cookiecutter_cmd = [
+        "cookiecutter",
+        str(template_path),
+        *[f"{k}={v}" for k, v in context.items()],
+    ]
+
+    if no_input:
+        cookiecutter_cmd.append("--no-input")
+
+    if force:
+        cookiecutter_cmd.append("--overwrite-if-exists")
+
+    return cookiecutter_cmd
+
+
+@app.command()
+def create_project(
+    project_name: str = typer.Argument(None, help="Name of the project"),
+    template: str = typer.Option(
+        "pyproject", "--template", "-t", help="Template to use for project creation"
+    ),
+    no_input: bool = typer.Option(
+        False, "--no-input", "-y", help="Skip prompts and use default values"
+    ),
+    force: bool = typer.Option(False, "--force", "-f", help="Overwrite existing project directory"),
+):
+    """Create a new project from a specified template."""
+    template_path = _validate_template(template)
+    context = _get_context()
+    if project_name:
+        context["project_name"] = project_name
+
+    cookiecutter_cmd = _build_cookiecutter_command(template_path, context, no_input, force)
+
+    try:
+        result = subprocess.run(cookiecutter_cmd, text=True, check=True)
+        console.print("[green]Project created successfully![/]")
+
+        if result.stdout:
+            console.print(f"[green]{result.stdout.strip()}[/]")
+
+    except subprocess.CalledProcessError as e:
+        console.print("[red]Project creation failed:[/]")
+        console.print(f"Command: {' '.join(e.cmd)}")
+
+        if e.stdout:
+            console.print("[yellow]Standard Output:[/]")
+            console.print(e.stdout)
+
+        if e.stderr:
+            console.print("[red]Error Output:[/]")
+            console.print(e.stderr)
+
+        raise typer.Exit(code=1)  # noqa: B904
+
+
+if __name__ == "__main__":
+    app()