Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/winterhazel/sigaa-for-kotlin

API não oficial para a leitura otimizada de dados do SIGAA.
https://github.com/winterhazel/sigaa-for-kotlin

android api java kotlin sigaa web-scraping

Last synced: about 1 month ago
JSON representation

API não oficial para a leitura otimizada de dados do SIGAA.

Awesome Lists containing this project

README

        

[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]

SIGAA for Kotlin


API não oficial para a leitura otimizada de dados do SIGAA


Documentação »



Tabela de Conteúdos



  1. Sobre


  2. Instalação

  3. Uso

  4. Licença

  5. Contato

  6. Agradecimentos

## Sobre

Esta biblioteca possibilita a leitura de informações cadastradas no SIGAA (Sistema Integrado de Gestão de Atividades Acadêmicas) por meio de web scraping de maneira otimizada.

A API foi desenvolvida para o [SIGAA do Instituto Federal Catarinense](https://sig.ifc.edu.br/sigaa/), mas muito provavelmente pode ser adaptada para o sistema de outras instituições.

(voltar ao topo)

### Funcionalidades

A API consegue obter do SIGAA:
- Arquivos enviados pelos docentes
- Anexos
- Aulas
- Avaliações
- Conteúdos
- Disciplinas (turmas virtuais)
- Frequência
- Informações do usuário logado
- Notas
- Notícias
- Participantes das turmas virtuais
- Questionários
- Referências
- Tarefas

(voltar ao topo)

### Tecnologias utilizadas

* [OkHttp](https://github.com/square/okhttp/)
* [Timber](https://github.com/JakeWharton/timber/)
* [jsoup](https://github.com/jhy/jsoup/)

(voltar ao topo)

## Instalação

1. Clone o repositório para a pasta raiz do seu projeto
```sh
git clone https://github.com/winterhazel/sigaa-for-kotlin.git
```
2. Adicione no `settings.gradle`
```groovy
include ':sigaa-for-kotlin'
```
3. Adicione no `build.gradle` da sua aplicação
```groovy
implementation project(path: ':sigaa-for-kotlin')
```

(voltar ao topo)

## Uso

A interação com o sistema é feita por meio da classe SIGAA:
```kotlin
val sigaa = SIGAA(this)

if (sigaa.login("usuario", "senha")) {
// Logado com sucesso
for (disciplina in sigaa.getAllDisciplinas()) {
println(sigaa.getNoticias(disciplina))
println(sigaa.getTarefas(disciplina))
}
} else {
// Não foi possível logar
}
```

_Para mais exemplos, confira [/examples/](https://github.com/winterhazel/sigaa-for-kotlin/tree/master/examples)_

(voltar ao topo)

## Licença

Distribuído sob a Licença MIT. Veja `LICENSE.txt` para mais informações.

(voltar ao topo)

## Contato

Fabricio Duarte Júnior - [email protected]

(voltar ao topo)

## Agradecimentos

* [Best-README-Template](https://github.com/othneildrew/Best-README-Template/)

(voltar ao topo)

[license-shield]: https://img.shields.io/github/license/winterhazel/sigaa-for-kotlin.svg?style=for-the-badge
[license-url]: https://github.com/winterhazel/sigaa-for-kotlin/blob/master/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/fabricio-duarte-júnior-676601231