How robsonfe/iponto-api works
Project type and purpose
• This is a backend-only RESTful API built with Python, Django and Django REST Framework.
• Purpose: manage employee time-punch records by company, produce monthly reports, and enrich data via an external AI service (DeepSeek).
File structure
• Top-level:
• core/ – Django project settings, URL routing, ASGI/WSGI
• api/ – Django app containing models, serializers, views, permissions, swagger mixins, migrations
• docs/ – documentation files
• manage.py, requirements.txt, .env.example
• api/ substructure follows logical modules:
• model/ – domain models (Company, Employee, CustomUser)
• serializers/ – translate Django models to/from JSON
• view/ – view classes for each resource (authentication, company, employee, transferer)
• permissions/ – custom DRF permissions
• swagger/ – mixins to auto-generate API docs
• utils/ – support modules (e.g., allowed_tags)
README insights
• Stack: Python, Django, DRF, PostgreSQL, external DeepSeek AI.
• Key use cases: user signup/login, CRUD on time entries, monthly report generation, real-time dashboards with AI-powered metrics.