Skip to content

fabiommendes/salic-api

 
 

Repository files navigation

SALIC api Open Source Love Open Source Love

API aberta para o sistema SALIC. Tem por objetivo expor os dados de projetos da lei Rouanet.

A documentação da API pode ser acessada aqui.

O projeto ainda se encontra em implantação, sujeito ainda a muitas alterações, reformulações e atualizacões.

Requisitos

A aplicação foi testada em ambientes LINUX com distribuições Debian e Ubuntu.

Os requisitos mínimos de hardware recomendados podem variar muito dependendo do ambiente onde será implantada e ainda não foram oficializados. O seguinte, contudo, deve oferecer um desempenho satisfatório:

  • Processador Dual Core 2 GHz
  • 2 GB de RAM
  • 2 GB livres em disco

Instalação Automatizada

Execute como root o script install.sh

$ chmod +x install.sh
$ sudo ./install.sh

Se tudo ocorrer bem, a aplicação deve estar instalada em /opt/salic/salic-api/, pronta para uso, bastando apenas configurar alguns parâmetros

Instalação Manual

Dependências básicas

  • python-dev
  • python-pip
  • freetds-dev
  • libxml2-dev
  • libxslt1-dev
  • libz-dev

Pacotes python

Basta executar

$ sudo pip install -r requirements.txt

Caso apareça a seguinte mensagem..

Could not import setuptools which is required to install from a source distribution.
Please install setuptools.

..basta reinstalar o setuptools

sudo pip install -U setuptools

Configuração

Edite o arquivo salic-api/app/example_config.py de acordo com seu ambiente. Edite o arquivo salic-api/app/general_config.py apontando o arquivo de configuração a ser usado.

Execução

Por padrão a aplicação executa com o web server Tornado

O executável é o arquivo run.py

$ python run.py

Caso tenha optado pela instalação automatizada, basta executar

$ /etc/init.d/salic-api start

Ao executar

$ /etc/init.d/salic-api

Você pode conferir os demais comandos disponíveis

Teste

Para verificar se a API está de fato executando corretamente, faça uma requisição para a URL

http://localhost:8000/test

Se tudo estiver correto, você deve obter uma resposta com conteúdo:

{"content": "API is up and running :D"}

License

Licensed under the GPL License.

Releases

No releases published

Packages

No packages published

Languages

  • Python 98.2%
  • Shell 1.8%