update

Author: npv2k1

.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+  "python.testing.pytestArgs": ["tests"],
+  "python.testing.unittestEnabled": false,
+  "python.testing.pytestEnabled": true
+}

Dockerfile

@@ -1,25 +1,45 @@
 FROM python:3.11-slim AS base
-ENV LANG=C.UTF-8 \
-  LC_ALL=C.UTF-8 \
-  PYTHONDONTWRITEBYTECODE=1 \
-  PYTHONFAULTHANDLER=1
+
+# Set Python environment variables
+ENV PYTHONDONTWRITEBYTECODE=1 \
+    PYTHONUNBUFFERED=1 \
+    PYTHONFAULTHANDLER=1 \
+    LANG=C.UTF-8 \
+    LC_ALL=C.UTF-8
+
+# Install basic dependencies
 RUN apt-get update && \
-  apt-get install -y --no-install-recommends gcc && \
-  apt-get install -y ffmpeg libsm6 libxext6 && \
-  apt-get install -y zbar-tools && \
-  apt-get install -y libzbar-dev
-RUN pip install --upgrade pip
+    apt-get install -y --no-install-recommends \
+    gcc \
+    && rm -rf /var/lib/apt/lists/*
+
+# Upgrade pip
+RUN pip install --no-cache-dir --upgrade pip
 
 FROM base AS builder
+
+# Create and activate virtual environment
 RUN python -m venv /.venv
 ENV PATH="/.venv/bin:$PATH"
-COPY requirements.txt .
-RUN pip install -r requirements.txt
+
+# Install dependencies
+COPY pyproject.toml .
+RUN pip install --no-cache-dir .
 
 FROM base as runtime
+
+# Set working directory
 WORKDIR /app
+
+# Copy virtual environment from builder
 COPY --from=builder /.venv /.venv
 ENV PATH="/.venv/bin:$PATH"
-COPY . /app
+
+# Copy application code
+COPY . .
+
+# Expose port (adjust if needed)
 EXPOSE 8000
+
+# Run the application
 CMD ["python", "main.py"]

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-present Your Name or Organization
+
+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.

Makefile

@@ -1,6 +1,41 @@
-package:
-	pip freeze > requirements.txt
-venv:
-	source ./venv/bin/activate
-build:
-	docker build -t template-python .
+.PHONY: help install dev-install test format lint type-check clean build run
+
+help:  ## Show this help menu
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
+
+install:  ## Install production dependencies
+	uv pip install .
+
+dev-install:  ## Install development dependencies
+	uv pip install -e ".[dev]"
+
+test:  ## Run tests with pytest
+	pytest -v --cov=src --cov-report=term-missing
+
+format:  ## Format code with black and isort
+	black .
+	isort .
+
+lint:  ## Lint code with ruff
+	ruff check .
+
+type-check:  ## Run type checking with mypy
+	mypy src tests
+
+clean:  ## Clean build artifacts
+	rm -rf build/ dist/ *.egg-info/ .coverage .pytest_cache/ .mypy_cache/ .ruff_cache/
+	find . -type d -name __pycache__ -exec rm -rf {} +
+
+build:  ## Build Docker image
+	docker build -t template-python .
+
+run:  ## Run Docker container
+	docker run -it --rm template-python
+
+package:  ## Create requirements.txt
+	uv pip freeze > requirements.txt
+
+setup:  ## Initial project setup
+	uv venv
+	$(MAKE) dev-install
+	cp .env.example .env

README.md

@@ -1,2 +1,109 @@
-# template-python
-Template python project
+# Python Project Template
+
+A modern Python project template with best practices for development, testing, and deployment.
+
+## Features
+
+- Modern Python (3.11+) project structure
+- Development tools configuration (pytest, black, isort, mypy, ruff)
+- Docker support
+- GitHub Actions ready
+- Comprehensive documentation structure
+- Jupyter notebook support
+
+## Project Structure
+
+```
+.
+├── docs/               # Documentation files
+├── notebooks/         # Jupyter notebooks
+├── src/               # Source code
+│   ├── common/        # Common utilities and shared code
+│   ├── modules/       # Feature modules
+│   │   └── api/       # API related code
+│   ├── shared/        # Shared resources
+│   └── utils/         # Utility functions
+└── tests/             # Test files
+```
+
+## Getting Started
+
+### Prerequisites
+
+- Python 3.11 or higher
+- [uv](https://github.com/astral-sh/uv) for dependency management
+
+### Installation
+
+1. Clone the repository:
+```bash
+git clone https://github.com/yourusername/template-python.git
+cd template-python
+```
+
+2. Create a virtual environment and install dependencies:
+```bash
+uv venv
+source .venv/bin/activate  # On Windows: .venv\Scripts\activate
+uv pip install -e ".[dev]"
+```
+
+3. Copy the environment file and adjust as needed:
+```bash
+cp .env.example .env
+```
+
+### Development
+
+This project uses several development tools:
+
+- **pytest**: Testing framework
+- **black**: Code formatting
+- **isort**: Import sorting
+- **mypy**: Static type checking
+- **ruff**: Fast Python linter
+
+Run tests:
+```bash
+pytest
+```
+
+Format code:
+```bash
+black .
+isort .
+```
+
+Run type checking:
+```bash
+mypy src tests
+```
+
+Run linting:
+```bash
+ruff check .
+```
+
+### Docker
+
+Build the Docker image:
+```bash
+make build
+```
+
+Run the container:
+```bash
+make run
+```
+
+## Contributing
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add some amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.

docs/README.md

@@ -0,0 +1,39 @@
+# Project Documentation
+
+Welcome to the documentation for the Python Template Project.
+
+## Table of Contents
+
+1. [Getting Started](getting-started.md)
+2. [Project Structure](project-structure.md)
+3. [Development Guide](development.md)
+4. [API Documentation](api.md)
+5. [Testing Guide](testing.md)
+6. [Deployment Guide](deployment.md)
+
+## Overview
+
+This template provides a foundation for Python projects with:
+
+- Modern Python project structure
+- Development tooling configuration
+- Testing framework setup
+- Docker support
+- Documentation templates
+- CI/CD examples
+
+## Quick Links
+
+- [Installation Guide](getting-started.md#installation)
+- [Development Setup](development.md#setup)
+- [Running Tests](testing.md#running-tests)
+- [Docker Guide](deployment.md#docker)
+- [API Reference](api.md#endpoints)
+
+## Contributing
+
+See our [Contributing Guide](CONTRIBUTING.md) for details on how to contribute to this project.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](../LICENSE) file for details.

main.py

@@ -1 +1,59 @@
-print("Hello, World!")
+#!/usr/bin/env python3
+
+import logging
+import os
+from pathlib import Path
+from typing import Optional
+
+# Configure logging
+logging.basicConfig(
+    level=logging.INFO,
+    format="%(asctime)s - %(name)s - %(levelname)s - %(message)s",
+)
+logger = logging.getLogger(__name__)
+
+
+def setup_environment() -> dict[str, str]:
+    """Load environment variables from .env file."""
+    env_vars = {}
+    env_path = Path(".env")
+    
+    if env_path.exists():
+        with env_path.open() as f:
+            for line in f:
+                line = line.strip()
+                if line and not line.startswith("#"):
+                    key, value = line.split("=", 1)
+                    env_vars[key.strip()] = value.strip()
+    
+    return env_vars
+
+
+def main() -> None:
+    """Main application entry point."""
+    try:
+        # Load environment variables
+        env_vars = setup_environment()
+        app_name = env_vars.get("APP_NAME", "template-python")
+        env = env_vars.get("ENV", "development")
+        debug = env_vars.get("DEBUG", "false").lower() == "true"
+
+        # Configure logging level based on debug setting
+        if debug:
+            logging.getLogger().setLevel(logging.DEBUG)
+            logger.debug("Debug mode enabled")
+
+        logger.info(f"Starting {app_name} in {env} environment")
+
+        # Your application initialization code here
+        # For example:
+        # app = create_app()
+        # app.run()
+
+    except Exception as e:
+        logger.error(f"Application failed to start: {e}", exc_info=True)
+        raise
+
+
+if __name__ == "__main__":
+    main()