AI SummaryYou are an expert Python developer working on ngx-renamer, an AI-powered document title generator for Paperless NGX. Your role is to maintain, test, and improve the codebase while following established conventions. All LLM providers inherit from and are registered in the provider registry: Always t
Install
Copy this and paste it into Claude Code, Cursor, or any AI assistant:
I want to set up the "ngx-renamer Development Agent" agent in my project. Please run this command in my terminal: # Add AGENTS.md to your project root curl --retry 3 --retry-delay 2 --retry-all-errors -o AGENTS.md "https://raw.githubusercontent.com/chriskoch/ngx-renamer/main/AGENTS.md" Then explain what the agent does and how to invoke it.
Description
AI coding agent for ngx-renamer, a Paperless NGX document title generator
Project Overview
Tech Stack: • Python 3.8+ • OpenAI API (GPT-4o, GPT-4o-mini) with structured outputs • Anthropic Claude API (Claude 3.5 Sonnet) with tool calling • Ollama API (local LLM support) with JSON schema validation • PyYAML for configuration • pytest for testing • Docker for deployment Project Structure: ` ngx-renamer/ ├── change_title.py # Main entry point ├── modules/ │ ├── base_llm_provider.py # Abstract base class for LLM providers │ ├── openai_titles.py # OpenAI integration │ ├── claude_titles.py # Anthropic Claude integration │ ├── ollama_titles.py # Ollama integration │ ├── paperless_ai_titles.py # Paperless API orchestrator │ ├── logger.py # Centralized logging configuration │ ├── constants.py # Constants and schemas │ ├── exceptions.py # Custom exception hierarchy │ ├── llm_factory.py # Provider factory with registry pattern │ ├── paperless_client.py # Paperless NGX API client │ └── providers/ # Provider plugin directory │ └── __init__.py # Provider registry and auto-discovery ├── scripts/ │ ├── init-and-start.sh # Docker entrypoint │ ├── setup-venv-if-needed.sh # Venv initialization │ └── post_consume_wrapper.sh # Post-consume hook ├── tests/ │ ├── conftest.py # Test fixtures │ ├── fixtures/ # Test data (YAML configs) │ └── integration/ # Integration tests ├── settings.yaml # Configuration file ├── requirements.txt # Runtime dependencies └── requirements-dev.txt # Development dependencies `
AGENTS.md
You are an expert Python developer working on ngx-renamer, an AI-powered document title generator for Paperless NGX. Your role is to maintain, test, and improve the codebase while following established conventions.
Create virtual environment
python3 -m venv .venv source .venv/bin/activate # On Windows: .venv\Scripts\activate
Install dependencies
pip install -r requirements.txt requirements-dev.txt
Discussion
Health Signals
My Fox Den
Community Rating
Sign in to rate this booster