{"id":38080333,"url":"https://github.com/odch/aircraft-list","last_synced_at":"2026-01-16T20:48:01.167Z","repository":{"id":320332478,"uuid":"1080641248","full_name":"odch/aircraft-list","owner":"odch","description":null,"archived":false,"fork":false,"pushed_at":"2026-01-12T07:22:15.000Z","size":128,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-01-12T17:33:29.236Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/odch.png","metadata":{"files":{"readme":"README.md","changelog":"changes_summary.txt","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-10-21T16:50:19.000Z","updated_at":"2026-01-12T07:22:19.000Z","dependencies_parsed_at":"2025-10-23T08:31:49.970Z","dependency_job_id":"f69205a0-af9c-4b51-952c-100ab380f8e9","html_url":"https://github.com/odch/aircraft-list","commit_stats":null,"previous_names":["odch/aircraft-list"],"tags_count":24,"template":false,"template_full_name":null,"purl":"pkg:github/odch/aircraft-list","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/odch%2Faircraft-list","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/odch%2Faircraft-list/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/odch%2Faircraft-list/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/odch%2Faircraft-list/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/odch","download_url":"https://codeload.github.com/odch/aircraft-list/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/odch%2Faircraft-list/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28482314,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-16T11:59:17.896Z","status":"ssl_error","status_checked_at":"2026-01-16T11:55:55.838Z","response_time":107,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-01-16T20:48:01.048Z","updated_at":"2026-01-16T20:48:01.139Z","avatar_url":"https://github.com/odch.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Aircraft Registry\n\nA comprehensive registry of all aircraft registered in Switzerland. This serves as a single source of truth for multiple projects requiring aircraft data.\n\n## Overview\n\nThis registry contains essential information for each aircraft:\n- **Registration**: Swiss aircraft registration code (e.g., HB-1234)\n- **ICAO Aircraft Type**: ICAO aircraft type designator\n- **Aircraft Type**: Aircraft type description \n- **MTOM**: Maximum Take-Off Mass in kg\n\n## Data Format\n\nThe registry uses JSON format for maximum compatibility and ease of integration:\n\n```json\n{\n  \"version\": \"1.0.0\",\n  \"last_updated\": \"2025-10-21T17:31:59+02:00\",\n  \"total_count\": 4,\n  \"aircraft\": [\n    {\n      \"registration\": \"HB-1000\",\n      \"icao_aircraft_type\": \"GLID\",\n      \"aircraft_type\": \"Glider\",\n      \"mtom\": 340\n    }\n  ]\n}\n```\n\n## Files\n\n- `aircraft.json` - Main registry file containing all aircraft data\n- `schema.json` - JSON Schema for data validation\n- `README.md` - This documentation file\n\n## Usage\n\n### For Nightly Database Imports\n\n```bash\ncurl -s https://raw.githubusercontent.com/odch/aircraft-list/main/aircraft.json | jq '.aircraft'\n```\n\n### Data Validation\n\nValidate your aircraft data against our schema:\n\n```bash\npip install jsonschema\npython3 -c \"import json, jsonschema; jsonschema.validate(json.load(open('aircraft.json')), json.load(open('schema.json')))\"\n```\n\n## Data Sources\n\n### Primary Data Sources\n\n**Swiss Federal Office of Civil Aviation (BAZL)**\n- License: Public data\n- Usage: Aircraft registrations, types, and technical specifications\n- API: `https://app02.bazl.admin.ch/web/bazl-backend/lfr/csv`\n\n### Data Processing\n\n- Aircraft data is sourced from the BAZL aircraft registry\n- Only active aircraft (Registered, Reserved, Reservation Expired, Registration in Progress) are included\n- Data is filtered to include only essential fields: Registration, ICAO Type, Aircraft Type, and MTOM\n- Custom overrides can be applied for additional aircraft or corrections\n\n## Maintenance\n\n### Automated Workflow\n\nThis registry uses a GitOps workflow with automated data synchronization and manual review/release process.\n\n#### 🤖 Automated Sync Process\n\nEvery Monday at 6:00 AM UTC (or manually triggered), GitHub Actions automatically:\n\n1. Downloads fresh data from BAZL API\n2. Processes data using `sync_aircraft.py` \n3. Creates `aircraft-staging.json` with latest information\n4. Compares staging vs production data\n5. If changes detected:\n   - Commits staging file to repository\n   - Generates detailed change summary\n   - Creates GitHub Issue for manual review\n\n#### 👤 Review \u0026 Release Process\n\nWhen automation detects changes, you receive a GitHub Issue with:\n- Detailed change summary and statistics\n- Instructions for next steps\n- Automatic labels for easy tracking\n\n**🤖 Automated Release (Recommended)**\n\nSimply comment on the GitHub Issue with one of these commands:\n\n**To approve and release:**\n- `!release patch` - For data updates, new aircraft, corrections\n- `!release minor` - For new fields, backward-compatible changes\n- `!release major` - For breaking changes, schema updates\n- `!release patch Fixed aircraft data` - Add optional description\n\n**To reject:**\n- `!reject` or `!reject Reason for rejection`\n\nWhat happens automatically:\n1. ✅ Validates staging data\n2. ✅ Creates production backup\n3. ✅ Bumps version (patch/minor/major)\n4. ✅ Releases to production\n5. ✅ Commits \u0026 creates Git tag\n6. ✅ Closes issue with summary\n\n**🖥️ Manual Release (Legacy)**\n\nFor local development or when automation fails:\n- **Review:** Run `python3 review_changes.py` to see detailed changes\n- **Approve:** Run `python3 release.py` to promote staging → production\n- **Reject:** Do nothing, changes remain in staging only\n\n#### 📁 Key Files\n\n- `aircraft.json` - 🟢 **PRODUCTION** (what applications consume)\n- `aircraft-staging.json` - 🟡 **STAGING** (automated updates)\n- `sync_aircraft.py` - Downloads and processes source data\n- `review_changes.py` - Shows differences between staging and production\n- `release.py` - Promotes staging to production with backups\n\n#### 🔒 Safety Features\n\n- **Production never touched by automation** - Always requires manual approval\n- **Automatic backups** created before each release\n- **Rollback capability** if issues arise\n- **Data validation** before promotion using JSON schema\n- **Clear audit trail** through Git commits and Issues\n\n#### ⚙️ GitHub Workflows\n\nThe project includes two main workflows:\n\n- **Sync Workflow** (`.github/workflows/sync.yml`) - Daily automated data sync (6:00 AM UTC)\n- **Release Workflow** (`.github/workflows/release.yml`) - Issue-based release management with `!release` and `!reject` commands\n\n### Custom Overrides\n\nYou can add custom aircraft or override existing data using `aircraft-overrides.json`:\n\n```json\n{\n  \"HB-CUST\": {\n    \"icao_aircraft_type\": \"B738\",\n    \"aircraft_type\": \"Aeroplane\",\n    \"mtom\": 79000\n  }\n}\n```\n\nTo use custom overrides:\n\n```bash\npython3 sync_aircraft.py --overrides aircraft-overrides.json\n```\n\n### Manual Maintenance\n\n#### Adding Individual Aircraft (Not Recommended)\n\nFor emergency additions only. Prefer the automated sync process for data quality.\n\n1. Ensure the aircraft has a valid registration code\n2. Add entry to the `aircraft` array in `aircraft.json`\n3. Update `total_count` field  \n4. Update `last_updated` timestamp\n5. Validate against schema\n6. Commit changes\n\n### Semantic Versioning\n\n- **Patch (x.x.X)**: Data updates, corrections, new aircraft\n- **Minor (x.X.x)**: New fields, backward-compatible schema changes\n- **Major (X.x.x)**: Breaking changes, incompatible schema updates\n\n## Setup\n\n### Requirements\n\n```bash\npip install -r requirements.txt\n```\n\n### Initial Sync\n\n```bash\n# Sync data from BAZL\npython3 sync_aircraft.py\n\n# Review what changed\npython3 review_changes.py\n\n# Release to production  \npython3 release.py\n```\n\n## Contributing\n\n1. Fork the repository\n2. Create a feature branch\n3. Make your changes\n4. Test with schema validation\n5. Submit a pull request\n\n## License\n\n### Registry Software \u0026 Code\n\nThis project (excluding data) is licensed under the MIT License.\n\n### Data Licensing \u0026 Attribution\n\nThe aircraft data is sourced from:\n- **Swiss Federal Office of Civil Aviation (BAZL)**: Public data\n\n### Usage Compliance\n\nWhen using this registry:\n- Verify data freshness for critical applications\n- Understand that aircraft registration data can change frequently\n- Consider the data processing pipeline when interpreting results\n\n### Disclaimer\n\nThis registry is provided \"as is\" without warranty. While we strive for accuracy, always verify critical information with official sources.\n\n## Support\n\n- **Issues**: Report bugs and request features via GitHub Issues\n- **Documentation**: This README and inline code documentation\n- **Community**: Contribute via Pull Requests\n\n---\n\n## About\n\n**Aircraft Registry** - Comprehensive Swiss aircraft database\n\n- **License**: MIT (code), Public Domain (data attribution to BAZL)\n- **Maintainer**: ODCH (Online Drone Control Hub)\n- **Data Source**: Swiss Federal Office of Civil Aviation (BAZL)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fodch%2Faircraft-list","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fodch%2Faircraft-list","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fodch%2Faircraft-list/lists"}