{"id":46314989,"url":"https://github.com/viniciusmecosta/spe-api","last_synced_at":"2026-04-13T04:09:12.355Z","repository":{"id":339665919,"uuid":"1123802076","full_name":"viniciusmecosta/spe-api","owner":"viniciusmecosta","description":null,"archived":false,"fork":false,"pushed_at":"2026-02-20T21:37:10.000Z","size":212,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-02-21T01:50:47.041Z","etag":null,"topics":["alembic","fastapi","openpyxl","python","sqlalchemy"],"latest_commit_sha":null,"homepage":"","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/viniciusmecosta.png","metadata":{"files":{"readme":"README.md","changelog":null,"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-12-27T16:49:24.000Z","updated_at":"2026-02-20T21:36:59.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/viniciusmecosta/spe-api","commit_stats":null,"previous_names":["viniciusmecosta/spe-api"],"tags_count":15,"template":false,"template_full_name":null,"purl":"pkg:github/viniciusmecosta/spe-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/viniciusmecosta%2Fspe-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/viniciusmecosta%2Fspe-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/viniciusmecosta%2Fspe-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/viniciusmecosta%2Fspe-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/viniciusmecosta","download_url":"https://codeload.github.com/viniciusmecosta/spe-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/viniciusmecosta%2Fspe-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30083009,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-04T13:22:36.021Z","status":"ssl_error","status_checked_at":"2026-03-04T13:20:45.750Z","response_time":59,"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":["alembic","fastapi","openpyxl","python","sqlalchemy"],"created_at":"2026-03-04T14:02:56.346Z","updated_at":"2026-03-04T14:03:00.876Z","avatar_url":"https://github.com/viniciusmecosta.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SPE - Sistema de Ponto Eletrônico\n\n## Sobre o Projeto\n\nO **SPE** é uma API backend responsável pela centralização e automação do controle de assiduidade de colaboradores. A solução gerencia registros de ponto, definição de jornadas de trabalho, tratamento de justificativas, consolidação de horas trabalhadas e execução do fechamento mensal.\n\nA aplicação foi projetada com foco em confiabilidade, organização em camadas e facilidade de evolução, permitindo sua integração com sistemas de recursos humanos, dispositivos de coleta de ponto e ferramentas de análise gerencial.\n\n## Stack Tecnológica\n\n* **Linguagem:** Python 3.11\n* **Framework Web:** FastAPI\n* **Persistência:** SQLite\n* **ORM:** SQLAlchemy\n* **Versionamento de esquema:** Alembic\n* **Autenticação e Segurança:** JWT e hash de senhas com Passlib (Bcrypt)\n* **Processamento assíncrono e rotinas:** APScheduler\n* **Geração de relatórios:** OpenPyXL\n\n## Configuração do Ambiente\n\nA aplicação utiliza variáveis de ambiente para controle de comportamento e proteção de dados sensíveis. Antes da execução, crie um arquivo `.env` na raiz do projeto, podendo utilizar o `.env.example` como referência.\n\n### Configurações Gerais\n\n* **`PROJECT_NAME`**\n  Nome descritivo da aplicação.\n\n* **`API_V1_STR`**\n  Prefixo base das rotas da API.\n\n* **`TIMEZONE`**\n  Fuso horário utilizado para persistência e validação temporal dos registros.\n\n* **`UPLOAD_DIR`**\n  Diretório destinado ao armazenamento de arquivos enviados ou gerados pelo sistema.\n\n* **`EXCLUDED_EMPLOYEE_IDS`**\n  Lista de identificadores de colaboradores que devem ser ignorados por regras automatizadas.\n\n### Banco de Dados\n\n* **`SQLALCHEMY_DATABASE_URI`**\n  String de conexão utilizada pelo ORM. O padrão utiliza SQLite local.\n\n### Segurança e Autenticação\n\n* **`SECRET_KEY`**\n  Chave criptográfica utilizada na assinatura de tokens JWT.\n\n* **`ALGORITHM`**\n  Algoritmo de assinatura dos tokens.\n\n* **`ACCESS_TOKEN_EXPIRE_MINUTES`**\n  Tempo de expiração do token de acesso.\n\n* **`DEVICE_API_KEY`**\n  Chave estática para autenticação de dispositivos ou integrações externas responsáveis pelo envio de dados.\n\n### Usuário Administrador Inicial\n\n* **`FIRST_SUPERUSER`**\n  Identificador do usuário administrador criado na primeira inicialização.\n\n* **`FIRST_SUPERUSER_PASSWORD`**\n  Credencial inicial do usuário administrador.\n\n### Configurações de E-mail\n\n* **`SMTP_HOST`**\n  Servidor SMTP utilizado para envio de mensagens.\n\n* **`SMTP_PORT`**\n  Porta de comunicação com o servidor SMTP.\n\n* **`SMTP_USER`**\n  Credencial de autenticação SMTP.\n\n* **`SMTP_PASSWORD`**\n  Senha ou token de aplicação associado ao usuário SMTP.\n\n* **`EMAIL_FROM`**\n  Endereço remetente das notificações do sistema.\n\n* **`EMAIL_TO`**\n  Destinatário principal dos relatórios operacionais e backups automatizados.\n\n## Execução com Docker\n\nA aplicação está containerizada, garantindo padronização de ambiente e simplificação do processo de implantação.\n\nApós configurar o arquivo `.env`, execute:\n\n```bash\ndocker compose build\n```\n\nEm seguida, inicialize os serviços:\n\n```bash\ndocker compose up -d\n```\n\nDurante a inicialização, o processo de bootstrap executa automaticamente:\n\n* Criação do banco de dados\n* Aplicação das migrações estruturais\n* Provisionamento do usuário administrador inicial\n* Inicialização do servidor na porta 8000\n\nA documentação interativa da API estará disponível em:\n\n```\nhttp://localhost:8000/docs\n```\n\nPara encerrar a execução:\n\n```bash\ndocker compose down\n```\n\n## Estrutura do Projeto\n\nO projeto adota organização em camadas, promovendo separação de responsabilidades e melhor manutenibilidade.\n\n* **`/app/api/`**\n  Camada de exposição HTTP, responsável pelo roteamento e tratamento das requisições.\n\n* **`/app/core/`**\n  Configurações globais, segurança, carregamento de ambiente e dependências transversais.\n\n* **`/app/database/`**\n  Inicialização da engine, sessão e infraestrutura de persistência.\n\n* **`/app/domain/models/`**\n  Entidades ORM que representam o modelo de dados do sistema.\n\n* **`/app/repositories/`**\n  Abstração de acesso a dados, contendo operações de persistência.\n\n* **`/app/schemas/`**\n  Modelos de validação e serialização utilizados na comunicação da API.\n\n* **`/app/services/`**\n  Implementação das regras de negócio, cálculos operacionais e fluxos do domínio.\n\n* **`/alembic/`**\n  Histórico de versionamento do esquema do banco de dados.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fviniciusmecosta%2Fspe-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fviniciusmecosta%2Fspe-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fviniciusmecosta%2Fspe-api/lists"}