suapy 1.0.0

Uma biblioteca Python incrível e em pt-BR focada na vida do aluno acessando a API do SUAP (IFRN).

A biblioteca Python feita para estudantes brasileiros que usam o SUAP.
Acesse faltas, notas, provas e muito mais — com código limpo e em português.

---

✨ Por que o Suapy?

Você quer saber quantas faltas tem antes de reprovar. Quer ver quando é sua próxima prova. Quer jogar suas notas num DataFrame do Pandas e entender de vez o semestre. O Suapy faz isso tudo — em português, com poucas linhas.

---

📦 Instalação

pip install suapy

🐼 Usando Pandas? Instale com o extra

pip install suapy[pandas]

---

🚀 Primeiros passos

from suapy import Suap

suap = Suap()
suap.login("20201014040001", "sua_senha")

# 👤 Quem sou eu?
aluno = suap.ensino.obter_dados_aluno()
print(f"E aí, {aluno['nome_usual']}! 👋")

# 📅 Próxima prova
provas = suap.ensino.obter_proximas_avaliacoes()
if provas:
    p = provas[0]
    print(f"📌 Prova de {p['disciplina']} em {p['data_avaliacao']}")

# 📋 Situação das matérias
for d in suap.ensino.obter_diarios(2024, 1):
    print(f"• {d['disciplina']}: {d['numero_faltas']} faltas — {d['situacao']}")

---

🎒 O que você pode fazer com suap.ensino

Função	O que retorna
obter_dados_aluno()	Matrícula, curso, cotas e contatos
obter_diarios(ano, periodo)	Faltas, notas e situação por disciplina
obter_boletim(ano, periodo)	Médias finais e carga horária
obter_proximas_avaliacoes()	Datas de provas e trabalhos cadastrados
obter_mensagens_aluno()	Recados do SUAP ('lidas', 'nao_lidas', 'todas')
obter_turmas_virtuais(ano, per)	Links e participantes da turma virtual
obter_requisitos_conclusao()	Horas e matérias que faltam para formar

---

📊 Analisando suas notas com Pandas

from suapy import para_dataframe

boletim = suap.ensino.obter_boletim(2024, 1)
df = para_dataframe(boletim)

media = df['media_final_disciplina'].astype(float).mean()
print(f"📈 Sua média geral: {media:.2f}")

---

🔐 Tratando erros de login

from suapy import Suap, SuapAuthError

try:
    suap.login("usuario", "senha_errada")
except SuapAuthError:
    print("❌ Usuário ou senha incorretos.")

---

Feito com 💚 para os estudantes do IF e de todas as instituições que usam o SUAP

Não é afiliado ao IFRN nem ao projeto SUAP oficial.