Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
b5bdff3d54 | ||
|
|
5c4ac70450 | ||
|
|
ad1b55009a | ||
|
|
fd8aee3227 |
+1
-9
@@ -2,7 +2,6 @@
|
|||||||
|
|
||||||
# Application settings
|
# Application settings
|
||||||
APP_NAME="Core Code API"
|
APP_NAME="Core Code API"
|
||||||
APP_VERSION="1.0.0"
|
|
||||||
DEBUG=false
|
DEBUG=false
|
||||||
|
|
||||||
# Server settings
|
# Server settings
|
||||||
@@ -13,11 +12,4 @@ PORT=8083
|
|||||||
# CORS_ORIGINS=["http://192.168.86.149:82"]
|
# CORS_ORIGINS=["http://192.168.86.149:82"]
|
||||||
|
|
||||||
# Logging
|
# Logging
|
||||||
LOG_LEVEL=INFO
|
LOG_LEVEL=INFO
|
||||||
|
|
||||||
# Web Scraper Module
|
|
||||||
WEB_SCRAPER_REQUEST_TIMEOUT=30
|
|
||||||
WEB_SCRAPER_MAX_REDIRECTS=5
|
|
||||||
WEB_SCRAPER_USER_AGENT="Mozilla/5.0 (compatible; CoreCode/1.0)"
|
|
||||||
WEB_SCRAPER_DEFAULT_MAX_LENGTH=10000
|
|
||||||
WEB_SCRAPER_MAX_LINKS_TO_EXTRACT=50
|
|
||||||
@@ -0,0 +1,72 @@
|
|||||||
|
|
||||||
|
# AGENTS.md
|
||||||
|
|
||||||
|
> **Start every session by reading this file.**
|
||||||
|
> This file outlines the operational protocols, coding standards, and architectural decisions for this FastAPI project.
|
||||||
|
|
||||||
|
## 1. Agent Operational Protocols
|
||||||
|
|
||||||
|
### 🧠 Work Patterns (Plan-Act-Reflect)
|
||||||
|
* **Plan:** Before writing code, briefly outline your plan. Identify which files you will touch and what the side effects might be.
|
||||||
|
* **Act:** Execute the changes in small, atomic steps.
|
||||||
|
* **Reflect:** After coding, verify your work. Did you break existing tests? Did you add new tests?
|
||||||
|
|
||||||
|
### 🛡️ Git Discipline
|
||||||
|
* **NEVER commit to `main` or `master` directly.** Always create a feature branch: `feature/your-feature-name` or `fix/issue-description`.
|
||||||
|
* **Commit Messages:** Use the [Conventional Commits](https://www.conventionalcommits.org/) format.
|
||||||
|
* `feat: add user login endpoint`
|
||||||
|
* `fix: resolve database connection timeout`
|
||||||
|
* `refactor: split monolith dependency file`
|
||||||
|
* **Atomic Commits:** Keep commits small. One logical change = one commit.
|
||||||
|
|
||||||
|
### 📝 Changelog Maintenance
|
||||||
|
* **Update `CHANGELOG.md`** with every user-facing change.
|
||||||
|
* Format: `## [Unreleased] - YYYY-MM-DD` followed by `### Added`, `### Changed`, or `### Fixed`.
|
||||||
|
|
||||||
|
### 🚀 Release Flow
|
||||||
|
When changes are ready for deployment:
|
||||||
|
|
||||||
|
1. **Ask user if deploy cycle is desired **
|
||||||
|
|
||||||
|
2. **Update version** in `pyproject.toml`:
|
||||||
|
- Bug fixes: bump patch version (1.8.3 → 1.8.4)
|
||||||
|
- New features: bump minor version (1.8.4 → 1.9.0)
|
||||||
|
|
||||||
|
3. **Update CHANGELOG.md**:
|
||||||
|
- Move items from `[Unreleased]` to new version section
|
||||||
|
- Add release date: `## [1.8.4] - 2025-12-16`
|
||||||
|
|
||||||
|
4. **Commit and tag**:
|
||||||
|
```bash
|
||||||
|
git add -A
|
||||||
|
git commit -m "fix: description of changes"
|
||||||
|
git tag v1.8.4
|
||||||
|
git push origin main --tags
|
||||||
|
```
|
||||||
|
|
||||||
|
5. **CI/CD triggers automatically**:
|
||||||
|
- Gitea CI builds Docker image on new tag
|
||||||
|
- Watchtower pulls and deploys to production
|
||||||
|
- Verify deployment: `curl http://192.168.86.149:8000/health`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 2. FastAPI Architecture & Best Practices
|
||||||
|
*Reference: [FastAPI Best Practices](https://github.com/zhanymkanov/fastapi-best-practices)*
|
||||||
|
|
||||||
|
### 📂 Project Structure (Directory-based, NOT File-type based)
|
||||||
|
Do **not** group files by type (e.g., one huge `routers` folder). Group by **domain/module** inside a `src/` directory.
|
||||||
|
|
||||||
|
**Correct Structure:**
|
||||||
|
```text
|
||||||
|
src/
|
||||||
|
├── auth/
|
||||||
|
│ ├── router.py # Endpoints
|
||||||
|
│ ├── schemas.py # Pydantic models
|
||||||
|
│ ├── service.py # Business logic (CRUD, etc.)
|
||||||
|
│ ├── dependencies.py# Module-specific dependencies
|
||||||
|
│ └── config.py # Module-specific settings
|
||||||
|
├── posts/
|
||||||
|
│ ├── router.py
|
||||||
|
│ └── ...
|
||||||
|
└── main.py # App entry point
|
||||||
@@ -5,6 +5,20 @@ All notable changes to this project will be documented in this file.
|
|||||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
|
||||||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||||
|
|
||||||
|
## [1.2.1] - 2025-12-17
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
|
||||||
|
- Device control endpoint now returns correct new state after action (added 300ms delay for HA state propagation)
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- AGENTS.md with project coding guidelines and release flow documentation
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
|
||||||
|
- Removed obsolete web scraper settings from .env.example
|
||||||
|
|
||||||
## [1.2.0] - 2025-12-17
|
## [1.2.0] - 2025-12-17
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|||||||
+1
-1
@@ -1,6 +1,6 @@
|
|||||||
[project]
|
[project]
|
||||||
name = "core-api"
|
name = "core-api"
|
||||||
version = "1.2.0"
|
version = "1.2.1"
|
||||||
description = "Core Code API - Infrastructure management and tools API"
|
description = "Core Code API - Infrastructure management and tools API"
|
||||||
readme = "README.md"
|
readme = "README.md"
|
||||||
requires-python = ">=3.12"
|
requires-python = ">=3.12"
|
||||||
|
|||||||
@@ -4,6 +4,7 @@ Housekeeping Controller
|
|||||||
Provides API endpoints for home automation via Home Assistant.
|
Provides API endpoints for home automation via Home Assistant.
|
||||||
Designed for the Tatlock Housekeeper agent and other consumers.
|
Designed for the Tatlock Housekeeper agent and other consumers.
|
||||||
"""
|
"""
|
||||||
|
import asyncio
|
||||||
from fastapi import APIRouter, HTTPException, Query, Depends
|
from fastapi import APIRouter, HTTPException, Query, Depends
|
||||||
from typing import List, Dict, Any, Optional
|
from typing import List, Dict, Any, Optional
|
||||||
from pydantic import BaseModel, Field
|
from pydantic import BaseModel, Field
|
||||||
@@ -413,6 +414,9 @@ class HousekeepingController(BaseController):
|
|||||||
else: # toggle
|
else: # toggle
|
||||||
await ha.toggle(entity_id)
|
await ha.toggle(entity_id)
|
||||||
|
|
||||||
|
# Wait for HA to update state before fetching
|
||||||
|
await asyncio.sleep(0.3)
|
||||||
|
|
||||||
# Get new state
|
# Get new state
|
||||||
new_state = await ha.get_state(entity_id)
|
new_state = await ha.get_state(entity_id)
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user