Addarr/project_structure at main · Cyneric/Addarr · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
addarr/
├── src/                    # Source code directory
│   ├── api/               # API clients for external services
│   │   ├── __init__.py
│   │   ├── base.py       # Base API client with common functionality
│   │   ├── radarr.py     # Radarr API integration
│   │   ├── sonarr.py     # Sonarr API integration
│   │   ├── lidarr.py     # Lidarr API integration
│   │   ├── transmission.py # Transmission API integration
│   │   └── sabnzbd.py    # SABnzbd API integration
│   │
│   ├── bot/              # Telegram bot components
│   │   ├── __init__.py
│   │   ├── handlers/     # Command handlers
│   │   │   ├── __init__.py
│   │   │   ├── auth.py   # Authentication handler
│   │   │   ├── media.py  # Media management handler
│   │   │   ├── start.py  # Start/menu handler
│   │   │   ├── help.py   # Help handler
│   │   │   ├── status.py # Status and health monitoring
│   │   │   ├── sabnzbd.py # SABnzbd handler
│   │   │   └── transmission.py # Transmission handler
│   │   ├── keyboards/    # Keyboard layouts
│   │   │   ├── __init__.py
│   │   │   ├── media.py  # Media-related keyboards
│   │   │   ├── settings.py # Settings keyboards
│   │   │   └── common.py # Common keyboard layouts
│   │   └── conversations/ # Conversation handlers
│   │       ├── __init__.py
│   │       ├── auth.py   # Authentication flow
│   │       └── media.py  # Media addition flow
│   │
│   ├── config/           # Configuration management
│   │   ├── __init__.py
│   │   ├── settings.py   # Configuration handling and validation
│   │   └── defaults.py   # Default configuration values
│   │
│   ├── services/         # Business logic services
│   │   ├── __init__.py
│   │   ├── media.py      # Media service orchestration
│   │   ├── health.py     # Health monitoring service
│   │   ├── scheduler.py  # Job scheduling service
│   │   ├── translation.py # Translation service
│   │   ├── notification.py # Notification service
│   │   ├── transmission.py # Transmission service
│   │   └── sabnzbd.py    # SABnzbd service
│   │
│   ├── utils/            # Utility functions and helpers
│   │   ├── __init__.py
│   │   ├── logger.py     # Logging setup and configuration
│   │   ├── splash.py     # CLI splash screen and version info
│   │   ├── validation.py # Input validation helpers
│   │   ├── error_handler.py # Centralized error handling
│   │   ├── backup.py     # Configuration backup utilities
│   │   ├── chat.py       # Chat helper functions
│   │   ├── config_handler.py # Configuration file handling
│   │   ├── helpers.py    # General helper functions
│   │   ├── prerun.py     # Pre-run checks
│   │   └── validate_translations.py # Translation validation
│   │
│   ├── models/           # Data models and types
│   │   ├── __init__.py
│   │   ├── config.py     # Configuration models
│   │   ├── media.py      # Media-related models
│   │   └── notification.py # Notification models
│   │
│   ├── __init__.py
│   ├── definitions.py    # Global constants and paths
│   └── main.py          # Application entry point
│
├── scripts/             # Installation and utility scripts
│   ├── install.sh      # Linux/macOS installer
│   ├── install.ps1     # Windows installer
│   ├── addarr.service  # Linux systemd service file
│   └── addarr.service.ps1 # Windows service configuration
│
├── translations/         # Translation files
│   ├── addarr.template.yml # Translation template
│   ├── addarr.en-us.yml   # English translations
│   ├── addarr.de-de.yml   # German translations
│   ├── addarr.es-es.yml   # Spanish translations
│   ├── addarr.fr-fr.yml   # French translations
│   ├── addarr.it-it.yml   # Italian translations
│   ├── addarr.nl-be.yml   # Dutch translations
│   ├── addarr.pl-pl.yml   # Polish translations
│   └── addarr.pt-pt.yml   # Portuguese translations
│
├── helm/                # Kubernetes Helm chart
│   ├── Chart.yaml       # Chart metadata
│   ├── README.md        # Chart documentation
│   ├── values.yaml      # Default chart values
│   └── templates/       # Chart templates
│       ├── deployment.yaml
│       ├── service.yaml
│       ├── configmap.yaml
│       └── pvc.yaml
│
├── tests/              # Test suite
│   ├── __init__.py
│   ├── conftest.py     # Test configuration
│   ├── test_api/       # API tests
│   ├── test_services/  # Service tests
│   └── test_utils/     # Utility tests
│
├── docs/               # Documentation
│   ├── api/           # API documentation
│   ├── deployment/    # Deployment guides
│   └── development/   # Development guides
│
├── config.yaml          # User configuration
├── config_example.yaml  # Example configuration
├── run.py              # Application launcher
├── requirements.txt    # Production dependencies
├── requirements-dev.txt # Development dependencies
├── Dockerfile          # Docker build file
├── docker-compose.yml  # Docker compose config
├── .dockerignore       # Docker ignore file
├── .gitignore         # Git ignore file
├── .flake8            # Flake8 configuration
├── pyproject.toml     # Project metadata
├── setup.cfg          # Package configuration
├── CHANGELOG.md       # Version history
├── LICENSE           # MIT license
└── README.md         # Project documentation