Controle Acadêmico 📚

O objetivo desse crawler é obter os dados presentes no Controle Acadêmico.

Esse código tem como usuário principal os estudantes da Universidade Federal de Campina Grande (UFCG).

Comandos

Abaixo estão algumas pequenas explicações acerca dos comandos e seus retornos. Os exemplos abaixo foram baseados em uma exportação no formato JSON, entretanto, você é livre para escolher o formato de exportação desejado. Caso você tenha instalado a versão global, a parte pipenv run dos exemplos não é necessária.

Obs: Os dados retornados dos comandos abaixo irão estar localizados, por default, na pasta ~/Downloads/data.

Histórico

 $ pipenv run controle historico

Retorna os dados acerca das disciplinas do histórico acadêmico. Tais dados estão estruturados da seguinte maneira:

{
 codigo, # Código de cadastro da disciplina
 disciplina, # Nome da disciplina 
 tipo, # Tipo da disciplina ['Obrigatória', 'Extracurricular', 'Optativa']
 creditos, # Quantidades de créditos da disciplina
 carga_horaria, # A sua carga horária, em horas
 media, # A média do aluno nessa disciplina
 situacao, # A situação do aluno na disciplina ['Aprovado', 'Dispensa', 'Em curso']
 periodo # O período recomendado na qual a disciplina deve ser paga segundo o plano de curso 
}

Horários

 $ pipenv run controle horario

Retorna as disciplinas e seus respectivos horários e salas de um determinado período letivo. Eles estão estruturados da seguinte maneira:

{
 codigo, # Código de cadastro da disciplina
 disciplina, # Nome da disciplina
 turma, # Número da turma 
 creditos, # Quantidades de créditos da disciplina
 horarios: [ # Lista dos horários da disciplina 
  {
   dia, # Em formato de números [2,3,4,5,6]
   horario, # Horário da disciplina nesse dia 
   sala # Sala em que acontece a aula 
  },
  ...]
 carga_horaria # A sua carga horária, em horas
}

Colação de Grau

 $ pipenv run controle colacao

Mostra as informações acerca das quantidades de créditos por tipo (cadeiras obrigatórias, complementares, específicas...) pagas pelo aluno no seguinte formato:

              Créditos

Obrigatórios:           (X/132)
Optativos Específicos:  (X/40)
Optativos Gerais:       (X/16)

Credenciais

 $ pipenv run controle credenciais

Salva/Atualiza as credenciais do aluno em um arquivo user.json localizado em ~/controleAcademico/user.json.

help

Para saber mais detalhes acerca dos comandos disponíveis, é so adicionar a linha abaixo ao comando.

$ --help

Configuração

Para executar a aplicação, é necessário ter instalado o pip na sua máquina. Você pode verificar se você tem o pip instalado atráves desse comando.

$ pip --version

Development version

Instalando as dependências do projeto

# Instalando o gerenciador de dependências
$ pip install --user pipenv

# Instalando as dependências usando o pipenv
$ pipenv install

# Executando a versão development  da CLI  
$ pipenv run controle [COMMAND]

Releasing version

Caso você queira instalar o comando na sua máquina, será necessário ter a versão do pip para python 3

# Instalando as dependências da CLI
$ pip3 install --user --editable  .

# Executando a CLI em qualquer diretório do sistema
 $ controle [COMMAND]

A partir da instalação acima, o comando controle fica acessível através do terminal globalmente na sua máquina.

Estrutura

scraper/
   |_ spiders/
        |_ historico.py
        |_ horario.py
   |_ items.py
   |_ middlewares.py
   |_ pipelines.py
   |_ settings.py

util/
   |_credits.py

run.py
setup.py

Contribuição

Tudo que precisas saber para seres o senhor das PRs você pode encontrar no CONTRIBUTING .

Disclaimer: Obviamente, para ter o acesso ao Controle Acadêmico, é necessário fornecer matricula e senha, entretanto, eu não tenho nenhuma intenção de obter tais informações. Você pode dar uma olhada no código relacionado a isso acessando o arquivo run.py