# app-backend

**Repository Path**: zeaning/app-backend

## Basic Information

- **Project Name**: app-backend
- **Description**: kiro-practice
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-07-29
- **Last Updated**: 2025-08-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Python Project Template

A template for python projects. Intended for initialization of dev python repositories. This template includes:

- 🛠️ Python project setup with `pyproject.toml`
- 📦 Package structure with `src/` layout
- ✅ Testing with `pytest` and code coverage
- 🔍 Linting with `ruff` and type checking with `mypy`
- 🔄 Pre-commit hooks for code quality
- 🐳 Development container support
- 🤖 GitHub Actions workflows for CI/CD (coming soon)

## Quick Start

- **Create a new repository** using this template. To use the template, create a new repository.
  ![Create new repository](/.res/img/create_repo.png)

  Select the template from the list. Make sure to keep you repo private.
  ![Select the template](/.res/img/select_template.png)

  This should result in an initialized repository.

- **Rename the source directory** `src/python_project_template` to match your package name:

  ```bash
  mv src/python_project_template src/your_project_name
  ```

- **Update package metadata**:
  In `pyproject.toml`:

  - Change `name` to your package name (use underscores, e.g., `your_project_name`)
  - Update `authors` with your information
  - Update `description` and other metadata

  [OPTIONAL] In `.devcontainer/devcontainer.json`:

  - update name
    in `.devcontainer/devcontainer.json`

- **Update codeowners** in `.github/CODEOWNERS`.

- **[OPTIONAL - handleded by devcontainer] Install development dependencies**:

  ```bash
  pip install -e ".[dev]"
  pre-commit install
  ```

- **Start developing** in `src/your_project_name/`

## Development

### Setup

OPTIONAL - handleded by devcontainer

```bash
# Install package in development mode with all dependencies
pip install -e ".[dev]"

# Install pre-commit hooks (if not installed by default)
pre-commit install
```

### Running Tests

```bash
# Run all tests
pytest

# Run tests with coverage report
pytest --cov=src --cov-report=term-missing
```

## License

Copyright (c) 2025 Neusician GmbH. All rights reserved.