suap-api-wrapper

CLI e biblioteca Python para interagir com a API v2 do SUAP.

Funciona com qualquer instituição que utilize o SUAP — IFPI, IFRN, IFCE e outras. Basta informar a URL da sua instância no primeiro login.

---

• 📥 Instalação

  ---

  Instale via PyPI com pip install suap-api-wrapper.

  → Instalação

• 🔑 Autenticação

  ---

  Como o login, tokens e refresh automático funcionam.

  → Autenticação

• 💻 CLI

  ---

  Acesse o SUAP direto do terminal com suap <comando>.

  → CLI

• 🐍 Biblioteca Python

  ---

  Integre dados do SUAP em scripts, bots ou aplicações.

  → Biblioteca Python

• ⚠️ Exceções

  ---

  Referência de todas as exceções lançadas pelo wrapper.

  → Exceções

• 🔒 Segurança

  ---

  Boas práticas para proteger suas credenciais e tokens.

  → Segurança

• 🤝 Contribuindo

  ---

  Como contribuir com o projeto, abrir issues e enviar PRs.

  → Contribuindo

---

Quick start

1. Instale

pip install suap-api-wrapper

2. Faça login

suap login

Você será solicitado a informar a URL do seu SUAP, matrícula e senha.

3. Use

CLIBiblioteca Python

# Ver seus dados pessoais
suap meus-dados

# Listar semestres
suap periodos

# Listar diários de um semestre
suap diarios 2024.1

# Ver aulas de um diário (use o ID retornado acima)
suap aulas 42

from suap_api import SuapClient

with SuapClient() as client:
    dados = client.comum.get_my_data()
    periodos = client.edu.get_periods()
    diarios = client.edu.get_diaries("2024.1")

    if diarios:
        id_diario = diarios[0]["id"]
        aulas = client.edu.get_diary_classes(id_diario)

---

Compatibilidade

Qualquer instituição que utilize o SUAP. Formatos de URL aceitos no login:

Formato digitado	Resultado
suap.ifpi.edu.br	https://suap.ifpi.edu.br
https://suap.ifpi.edu.br/	https://suap.ifpi.edu.br
https://suap.ifpi.edu.br/api/v2	https://suap.ifpi.edu.br