{"id":42763629,"url":"https://github.com/dannymcc/may","last_synced_at":"2026-05-03T19:05:02.846Z","repository":{"id":335333216,"uuid":"1145079285","full_name":"dannymcc/may","owner":"dannymcc","description":"May is a web-based dashboard application that gives you a neat and clean interface for logging your fuel fill-ups for all of your vehicles. The application has full multi-user support, as well as multiple vehicles per user. Whenever you fill-up your car or motorcycle, keep the receipt and record the data in May.","archived":false,"fork":false,"pushed_at":"2026-04-27T16:41:38.000Z","size":3158,"stargazers_count":183,"open_issues_count":12,"forks_count":19,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-04-27T18:27:27.143Z","etag":null,"topics":["docker","flask","fleet","fuel","maintenance","python","self-hosted","vehicle"],"latest_commit_sha":null,"homepage":null,"language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dannymcc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2026-01-29T11:55:26.000Z","updated_at":"2026-04-27T16:23:40.000Z","dependencies_parsed_at":"2026-02-10T21:01:02.207Z","dependency_job_id":null,"html_url":"https://github.com/dannymcc/may","commit_stats":null,"previous_names":["dannymcc/may"],"tags_count":48,"template":false,"template_full_name":null,"purl":"pkg:github/dannymcc/may","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dannymcc%2Fmay","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dannymcc%2Fmay/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dannymcc%2Fmay/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dannymcc%2Fmay/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dannymcc","download_url":"https://codeload.github.com/dannymcc/may/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dannymcc%2Fmay/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32581040,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-03T06:36:36.687Z","status":"ssl_error","status_checked_at":"2026-05-03T06:36:09.306Z","response_time":103,"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":["docker","flask","fleet","fuel","maintenance","python","self-hosted","vehicle"],"created_at":"2026-01-29T21:00:41.711Z","updated_at":"2026-05-03T19:05:02.839Z","avatar_url":"https://github.com/dannymcc.png","language":"HTML","funding_links":["https://buymeacoffee.com/d3hkz6gwle"],"categories":[],"sub_categories":[],"readme":"# May\n\n[![\"Buy Me A Coffee\"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://buymeacoffee.com/d3hkz6gwle)\n\nA modern, self-hosted vehicle management application for tracking fuel consumption, expenses, reminders, and maintenance across your entire fleet.\n\n![Flask](https://img.shields.io/badge/Flask-Python-blue) ![GitHub Release](https://img.shields.io/github/v/release/dannymcc/may) ![License](https://img.shields.io/badge/license-MIT-green) ![Docker](https://img.shields.io/badge/Docker-Ready-2496ED) ![PWA](https://img.shields.io/badge/PWA-Ready-5A0FC8)\n\nNamed after James May, completing the trio of Top Gear presenters (alongside [Clarkson](https://github.com/linuxserver/Clarkson) and [Hammond](https://github.com/AlfHou/hammond)).\n\n## 📸 Screenshots\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"screenshots/dashboard.png\" alt=\"Dashboard\" width=\"45%\"\u003e\n  \u003cimg src=\"screenshots/vehicles.png\" alt=\"Vehicles\" width=\"45%\"\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"screenshots/vehicle_details.png\" alt=\"Vehicle Details\" width=\"45%\"\u003e\n  \u003cimg src=\"screenshots/integrations.png\" alt=\"Integrations\" width=\"45%\"\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"screenshots/import_export.png\" alt=\"Import/Export\" width=\"45%\"\u003e\n\u003c/p\u003e\n\n## 🚀 Features\n\n- **🚗 Multi-Vehicle Support**: Track cars, vans, motorbikes, and scooters with custom vehicle types\n- **⛽ Fuel Logging**: Record fill-ups with automatic consumption calculations (L/100km, MPG)\n- **⚡ Quick Entry Mode**: Rapid fuel logging with a streamlined interface\n- **💰 Expense Tracking**: Monitor maintenance, insurance, repairs, tax, and other costs by category\n- **🔄 Recurring Expenses**: Track regular payments like insurance, tax, and subscriptions\n- **🔧 Maintenance Schedules**: Plan and track scheduled maintenance with mileage/date intervals\n- **📅 Reminders**: Set up recurring reminders for MOT, service, insurance, and tax renewals\n- **🔔 Multi-Channel Notifications**: Get reminded via Email, ntfy, Pushover, or Webhooks\n- **📁 Document Storage**: Store important documents (insurance, registration, manuals) per vehicle\n- **⛽ Favorite Stations**: Save and quickly select your preferred fuel stations\n- **👥 Multi-User**: Share vehicles between family members or team members\n- **📊 Analytics Dashboard**: View spending trends and consumption statistics with interactive charts\n- **📎 Attachment Support**: Upload receipts and documents to fuel logs and expenses\n- **📄 PDF Reports**: Generate comprehensive vehicle reports for record-keeping\n- **🔧 Customizable Units**: Support for metric/imperial, multiple currencies\n- **🎛️ Menu Customization**: Show/hide menu items and set your preferred start page\n- **🌍 Internationalization**: Available in multiple languages (English, German, Spanish, French, and more)\n- **🎨 Custom Branding**: Personalize with your own logo, colors, and app name\n- **🌙 Dark Mode**: Toggle between light and dark themes\n- **📥 Import/Export**: Import from Fuelly CSV, export all data as JSON or CSV\n- **🇬🇧 DVLA Integration**: Look up UK vehicle MOT and tax status automatically\n- **📱 PWA Support**: Install as a mobile app with offline capabilities\n- **🔌 REST API**: Full API access for integrations and automation\n- **🏠 Home Assistant Integration**: Create sensors and automations for your vehicles\n- **📆 Calendar Subscription**: Subscribe to reminders in Apple Calendar, Google Calendar, Outlook\n- **🐳 Docker Ready**: Easy self-hosting via Docker\n\n## 📦 Installation\n\n### Quick Start with Docker\n\n```bash\n# Create a directory for May\nmkdir may \u0026\u0026 cd may\n\n# Download docker-compose.yml\ncurl -O https://raw.githubusercontent.com/dannymcc/may/main/docker-compose.yml\n\n# Start the container\ndocker compose up -d\n```\n\nOr run directly with Docker:\n\n```bash\ndocker run -d \\\n  --name may \\\n  -p 5050:5050 \\\n  -v may_data:/app/data \\\n  -e SECRET_KEY=your-secret-key \\\n  ghcr.io/dannymcc/may:latest\n```\n\nAccess the application at `http://localhost:5050`\n\n**First-time login:**\n- Username: `admin`\n- Password: Check your container logs for the auto-generated password\n\nOn first run, if no `ADMIN_PASSWORD` environment variable is set, May generates a secure random password and prints it to the console:\n\n```\n============================================================\nSECURITY NOTICE: Default admin account created\nUsername: admin\nPassword: \u003crandomly-generated-password\u003e\nPlease change this password immediately after first login!\nSet ADMIN_PASSWORD environment variable to avoid this message.\n============================================================\n```\n\nTo view the password, run:\n```bash\ndocker logs may\n```\n\n💡 **Tip:** Set `ADMIN_PASSWORD` in your docker-compose.yml or environment to use a fixed password.\n\n### Manual Installation\n\n```bash\n# Create virtual environment\npython3 -m venv venv\nsource venv/bin/activate\n\n# Install dependencies\npip install -r requirements.txt\n\n# Run the application\npython run.py\n```\n\n## ⚙️ Configuration\n\nCopy `.env.example` to `.env` and configure:\n\n```bash\n# Secret key for session encryption\nSECRET_KEY=your-secure-random-string\n\n# Database location (default: SQLite)\nDATABASE_URL=sqlite:///data/may.db\n\n# Upload folder for attachments\nUPLOAD_FOLDER=/app/data/uploads\n```\n\n### Environment Variables\n\n| Variable | Description | Default |\n|----------|-------------|---------|\n| `SECRET_KEY` | Session encryption key | Random |\n| `DATABASE_URL` | Database connection string | `sqlite:///data/may.db` |\n| `UPLOAD_FOLDER` | Path for file uploads | `/app/data/uploads` |\n| `TAILWIND_ASSET_URL` | Local Tailwind Play CDN JS path | `/static/vendor/tailwindcss.js` |\n| `TAILWIND_CDN_URL` | Tailwind CDN fallback URL | `https://cdn.tailwindcss.com` |\n| `HTMX_CDN_URL` | HTMX CDN URL | `https://unpkg.com/htmx.org@1.9.10` |\n\nBy default, Tailwind loads from `app/static/vendor/tailwindcss.js` and falls back to the CDN URL if the local asset is missing.\n\n## 🎯 Usage\n\n### Dashboard\nThe main dashboard shows an overview of all your vehicles with key statistics:\n- Total fuel costs and consumption averages\n- Recent fuel logs and expenses\n- Upcoming reminders and overdue alerts\n- Vehicle photo cards showing make/model/year and fuel type at a glance\n\n### Vehicles\nAdd and manage your vehicles with detailed information:\n- Make, model, year, and registration\n- Fuel type and tank capacity\n- Custom specifications and notes\n- Photo upload support\n- **Vehicle Sharing**: Mark a vehicle as \"Shared\" to make it visible and loggable by all users on the instance\n- **Upcoming Maintenance**: Vehicle detail pages show a live panel of scheduled maintenance tasks, with overdue and due-soon alerts\n- **Parts \u0026 Consumables**: Collapsible section on the vehicle page remembers your expand/collapse preference per vehicle\n\n### Fuel Logs\nTrack every fill-up with:\n- Date, odometer reading, and fuel amount\n- Total cost and price per unit\n- Full tank indicator for accurate consumption calculations\n- Automatic MPG/L per 100km calculations\n\n### Expenses\nCategorize all vehicle-related costs:\n- Maintenance \u0026 Repairs\n- Inspection (MOT, roadworthy checks)\n- Insurance\n- Tax \u0026 Registration\n- Parking \u0026 Tolls\n- Accessories\n- Other expenses\n\nRecord odometer readings alongside costs, and expand any expense row to see vendor and notes details inline.\n\n### Reminders\nNever miss important dates:\n- MOT/Inspection due dates\n- Service intervals\n- Insurance renewals\n- Tax payments\n- Custom reminders with flexible recurrence\n\n### Maintenance Schedules\nPlan regular maintenance tasks:\n- Set intervals by mileage or time (e.g., oil change every 10,000 km or 12 months)\n- Track completion history\n- Automatic reminder generation\n- Link to expenses when completed\n\n### Recurring Expenses\nTrack regular payments:\n- Insurance premiums\n- Road tax\n- Subscriptions and memberships\n- Custom recurrence patterns (monthly, quarterly, yearly)\n- Automatic calendar integration\n\n### Documents\nStore important vehicle documents:\n- Insurance certificates\n- Registration documents\n- Service manuals and instruction booklets (up to 300MB)\n- MOT certificates\n- Any file type (PDF, images, Word, Excel, text, ePub) with expiry date tracking\n\n### Fuel Stations\nSave your favorite stations:\n- Quick selection during fuel logging\n- Track prices at different stations\n- Notes and location information\n\n### Notifications\nConfigure your preferred notification method:\n- **Email**: SMTP server configuration (admin)\n- **ntfy**: Free push notifications via ntfy.sh or self-hosted\n- **Pushover**: iOS/Android push notifications\n- **Webhook**: HTTP POST for Home Assistant, Discord, Slack, etc.\n\n## 🔧 Admin Settings\n\nAdministrators can configure:\n- **SMTP Settings**: Email server for notifications\n- **Pushover**: Application token for push notifications\n- **DVLA API**: API key for UK vehicle lookups ([get one here](https://developer-portal.driver-vehicle-licensing.api.gov.uk/))\n- **Branding**: Custom logo, app name, tagline, and primary color\n- **User Management**: Create, edit, and manage user accounts\n\n## 🔌 API\n\nMay includes a REST API for automation and integrations:\n\n```bash\n# Generate an API key in Settings \u003e API\ncurl -H \"Authorization: Bearer may_your_api_key\" \\\n  http://localhost:5050/api/v1/vehicles\n```\n\nSee the API documentation at `/api/docs` when logged in.\n\n## 🔗 Integrations\n\n### Home Assistant\nCreate vehicle sensors in Home Assistant:\n\n```yaml\nsensor:\n  - platform: rest\n    name: \"May Vehicle Stats\"\n    resource: http://your-may-instance/api/ha/summary\n    headers:\n      Authorization: Bearer may_your_api_key\n    value_template: \"{{ value_json.alerts_count }}\"\n    json_attributes:\n      - total_vehicles\n      - total_cost\n```\n\nAvailable endpoints: `/api/ha/status`, `/api/ha/vehicles`, `/api/ha/alerts`, `/api/ha/summary`\n\n### Calendar Subscription\nSubscribe to reminders in your calendar app:\n\n1. Go to Settings \u003e Integrations \u003e Calendar\n2. Copy the webcal URL (for Apple Calendar, Outlook) or HTTPS URL (for Google Calendar)\n3. Add as a subscribed calendar in your app\n\nThe calendar includes:\n- Maintenance schedules\n- Recurring expense due dates\n- Document expiry dates\n- Custom reminders\n\n## 🌍 Supported Languages\n\nMay is available in the following languages:\n\n| Language | Code | Language | Code |\n|----------|------|----------|------|\n| English | `en` | Swedish | `sv` |\n| German (Deutsch) | `de` | Danish (Dansk) | `da` |\n| Spanish (Español) | `es` | Norwegian (Norsk) | `no` |\n| French (Français) | `fr` | Finnish (Suomi) | `fi` |\n| Italian (Italiano) | `it` | Japanese (日本語) | `ja` |\n| Dutch (Nederlands) | `nl` | Chinese (中文) | `zh` |\n| Portuguese (Português) | `pt` | Korean (한국어) | `ko` |\n| Polish (Polski) | `pl` | | |\n\nYou can change your language in **Settings \u003e Units \u0026 Values \u003e Language**.\n\n### Improving Translations\n\nTranslations were generated with AI assistance and may contain inaccuracies. If you spot an incorrect translation, contributions are very welcome:\n\n1. Translation files are located in `app/translations/\u003clang\u003e/LC_MESSAGES/messages.po`\n2. Edit the `msgstr` value for any incorrect entry\n3. Submit a pull request with your fix\n\n## 🛠️ Tech Stack\n\n- **Backend**: Python / Flask\n- **Database**: SQLite (easily swappable)\n- **Frontend**: Tailwind CSS, HTMX, Chart.js\n- **Server**: Gunicorn\n- **Notifications**: SMTP, ntfy, Pushover, Webhooks\n- **PDF Generation**: WeasyPrint\n\n## 🐛 Troubleshooting\n\n### Application Won't Start\n- Check that all dependencies are installed: `pip install -r requirements.txt`\n- Ensure the data directory is writable\n- Check logs for specific error messages\n\n### Database Issues\n- Default SQLite database is created at `data/may.db`\n- Ensure the directory exists and is writable\n- For schema updates, the app handles migrations automatically\n\n### Notification Issues\n- **Email**: Verify SMTP settings and credentials in admin settings\n- **ntfy**: Check your topic name is correct\n- **Pushover**: Ensure admin has configured the app token\n- **Webhook**: Verify the URL is accessible and accepts POST requests\n\n### PDF Generation\n- WeasyPrint requires system dependencies on some platforms\n- On Ubuntu/Debian: `apt-get install libpango-1.0-0 libpangocairo-1.0-0`\n- On macOS: `brew install pango`\n\n## 🤝 Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n### Development Setup\n1. Clone this repository\n2. Create a virtual environment: `python3 -m venv venv`\n3. Activate it: `source venv/bin/activate`\n4. Install dependencies: `pip install -r requirements.txt`\n5. Run in development mode: `python run.py`\n\n## 📝 License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## 📞 Support\n\n- **Issues**: [GitHub Issues](https://github.com/dannymcc/may/issues)\n- **Documentation**: This README and in-app help\n\n## 🙏 Acknowledgments\n\n- App icon design by [@lancetm714](https://github.com/lancetm714)\n\n---\n\n**Made with ❤️ by [Danny McClelland](https://github.com/dannymcc)**\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdannymcc%2Fmay","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdannymcc%2Fmay","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdannymcc%2Fmay/lists"}