{"id":34513715,"url":"https://github.com/leon1995/fwtv","last_synced_at":"2026-01-20T16:53:17.620Z","repository":{"id":143268825,"uuid":"614070338","full_name":"leon1995/fwtv","owner":"leon1995","description":"Verification that attendances comply with german rules. Also provide an integration to the api of FactorialHR","archived":false,"fork":false,"pushed_at":"2025-09-21T13:31:57.000Z","size":306,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-09-29T11:13:48.510Z","etag":null,"topics":["api","factorialhr","germany","working-time"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/leon1995.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2023-03-14T20:40:18.000Z","updated_at":"2025-09-21T13:31:57.000Z","dependencies_parsed_at":"2023-09-29T07:19:27.099Z","dependency_job_id":"612d1d0a-f6a3-4eb9-98dd-09c87758beba","html_url":"https://github.com/leon1995/fwtv","commit_stats":{"total_commits":17,"total_committers":1,"mean_commits":17.0,"dds":0.0,"last_synced_commit":"58f82166ae8c66a6d555c2c27f650ce4273075cc"},"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/leon1995/fwtv","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leon1995%2Ffwtv","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leon1995%2Ffwtv/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leon1995%2Ffwtv/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leon1995%2Ffwtv/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/leon1995","download_url":"https://codeload.github.com/leon1995/fwtv/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leon1995%2Ffwtv/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":27994528,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-12-24T02:00:07.193Z","response_time":83,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["api","factorialhr","germany","working-time"],"created_at":"2025-12-24T04:16:54.462Z","updated_at":"2025-12-24T04:16:55.349Z","avatar_url":"https://github.com/leon1995.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# FactorialHR Work Time Verification\n\n![pyversions](https://img.shields.io/pypi/pyversions/fwtv) ![implementation](https://img.shields.io/pypi/implementation/fwtv) ![status](https://img.shields.io/pypi/status/fwtv) ![pypi](https://img.shields.io/pypi/v/fwtv) ![dpm](https://img.shields.io/pypi/dm/fwtv) ![docker](https://img.shields.io/docker/pulls/ghcr.io/leon1995/fwtv)\n\nA web application built with [Reflex](https://reflex.dev) that verifies employee attendance records against German labor law requirements. The application integrates with FactorialHR's API to fetch attendance data and provides compliance checking with an intuitive web interface.\n\n## 🎯 Features\n\n- **German Labor Law Compliance**: Automatically verifies attendance against German work time regulations\n- **FactorialHR Integration**: Seamless connection to FactorialHR API for data retrieval\n- **Modern Web Interface**: Built with Reflex for a responsive, modern UI\n- **Docker Support**: Containerized deployment with multi-architecture support\n- **CI/CD Pipeline**: Automated testing, building, and deployment\n\n## 📋 Compliance Rules\n\nThe application verifies the following German labor law requirements:\n\n- ⏰ **6-hour rule**: Work time longer than 6 hours requires a 30-minute break\n- ⏰ **9-hour rule**: Work time longer than 9 hours requires a 45-minute break\n- ⏰ **10-hour rule**: Work time longer than 10 hours requires an 11-hour rest period\n- 🕕 **Time window**: Work time must be within 6:00 AM and 10:00 PM\n\n![main_window](./docs/images/working_time_verification.png \"Main Window\")\n\n## 🚀 Quick Start\n\n### Option 1: Docker (Recommended)\n\n```bash\n# Pull the latest development image\ndocker pull ghcr.io/leon1995/fwtv:dev\n\n# Run the container\ndocker run -p 8080:8080 \\\n  -e FACTORIAL_API_KEY=your_api_key \\\n  -e FACTORIAL_COMPANY_ID=your_company_id \\\n  ghcr.io/leon1995/fwtv:dev\n```\n\n### Option 2: Local Development\n\n```bash\n# Clone the repository\ngit clone https://github.com/leon1995/fwtv.git\ncd fwtv\n\n# Install dependencies\nuv sync --frozen\n\n# Configure environment\ncp .env.sample .env\n# Edit .env with your FactorialHR credentials\n\n# Run the application\nuv run reflex run --env prod\n```\n\n## 🐳 Docker Images\n\nThe project provides pre-built Docker images for easy deployment:\n\n| Tag | Description | Usage |\n|-----|-------------|-------|\n| `dev` | Latest development build | `ghcr.io/leon1995/fwtv:dev` |\n| `v1.0.0` | Specific release version | `ghcr.io/leon1995/fwtv:v1.0.0` |\n| `latest` | Latest stable release | `ghcr.io/leon1995/fwtv:latest` |\n\n### Multi-Architecture Support\n\nAll Docker images support both `linux/amd64` and `linux/arm64` architectures, making them compatible with:\n- Intel/AMD x86_64 systems\n- ARM64 systems (Apple Silicon, ARM servers)\n\n## ⚙️ Configuration\n\n### Environment Variables\n\nCreate a `.env` file with the following variables from [`.env.sample`](.env.sample)\n\n### FactorialHR Setup\n\n1. Log in to your FactorialHR account\n2. Navigate to Settings → API\n3. Generate an API key\n4. Note your Company ID from the URL or settings\n\n## 🏗️ CI/CD Pipeline\n\nThe project includes automated CI/CD pipelines:\n\n### Development Pipeline\n- **Triggers**: Push to main branch, pull requests\n- **Actions**: Linting, testing, Docker image building\n- **Output**: Development Docker images tagged as `dev`\n\n### Release Pipeline\n- **Triggers**: Git tags (e.g., `v1.0.0`)\n- **Actions**: Version extraction, Docker image building, GitHub release creation\n- **Output**: Versioned Docker images and GitHub releases\n\n### Workflow Features\n- ✅ Multi-architecture Docker builds (AMD64 + ARM64)\n- ✅ Automated testing across Python 3.11, 3.12, 3.13\n- ✅ Cross-platform compatibility (Linux, Windows, macOS)\n- ✅ GitHub Container Registry integration\n- ✅ Automated release management\n\n## 🧪 Development\n\n### Prerequisites\n\n- Python 3.13\n- [uv](https://docs.astral.sh/uv/) package manager\n- Docker (optional)\n\n### Setup Development Environment\n\n```bash\n# Install development dependencies\nuv sync --group dev\n\n# Run tests\nuv run pytest\n\n# Run linting\nuv run ruff check .\nuv run ruff format .\n\n# Run pre-commit hooks\nuv run pre-commit run --all-files\n```\n\n## 🤝 Contributing\n\nWe welcome contributions! Please follow these steps:\n\n1. **Fork** the repository\n2. **Create** a feature branch (`git checkout -b feature/amazing-feature`)\n3. **Install** development dependencies (`uv sync --group dev`)\n4. **Make** your changes\n5. **Run** tests (`uv run pytest`)\n6. **Commit** your changes (`git commit -m 'Add amazing feature'`)\n7. **Push** to the branch (`git push origin feature/amazing-feature`)\n8. **Open** a Pull Request\n\n### Development Guidelines\n\n- Follow the existing code style (enforced by Ruff)\n- Add tests for new functionality\n- Update documentation as needed\n- Ensure all CI checks pass\n\n## ⚠️ Disclaimer\n\n**Important**: This application is provided for informational purposes only. While it implements German labor law requirements, I do not guarantee complete compliance with current regulations. Labor laws may change, and this tool should not be considered legal advice.\n\n**Use at your own risk**: Always consult with legal professionals for official compliance verification.\n\n## 📄 License\n\nThis project is licensed under the GNU Affero General Public License v3 - see the [LICENSE](LICENSE) file for details.\n\n## 🔗 Links\n\n- **Homepage**: https://github.com/leon1995/fwtv\n- **Bug Tracker**: https://github.com/leon1995/fwtv/issues\n- **Changelog**: https://github.com/leon1995/fwtv/blob/main/CHANGELOG.md\n- **Docker Hub**: https://github.com/leon1995/fwtv/pkgs/container/fwtv\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fleon1995%2Ffwtv","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fleon1995%2Ffwtv","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fleon1995%2Ffwtv/lists"}