Algumas palavaras chaves como: "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", e "OPTIONAL" que podem ocorrer nesse documento (mas traduzidas) são interpretadas como descritas no RFC 2119.

Instalação - intro

Esta página tem como intenção guiar no processo de instalação do projeto para uso API.
A aplicação foi escrita em Python (versão 2.7) e Django Framework 1.11.

Considerações iniciais
O proceso de preparação e instalação assume que você está em algum ambiente UNIX, preferencialmente, Linux. Apesar disso, não deveria ser um impeditivo tentar em ambiente como Windows, embora passos adicionais, não cobertos aqui, possam ser necessário.

Todo o projeto foi desenvolvido e testado no GNU/Debian, versão 9.

Preparando o ambiente

Requerimentos inicias

  • Python 2.7 (isso deveria ser compatível com Python 3, mas não foi testado)
  • GNU Make
  • pip
  • Virtualenv
  • Git (opcional) - Necessário se a obtenção so source-code é via git clone (que é o recomendado)
  • SQLite 3 - Isso deveria vir por padrão com o Python.

Instalando o GNU Make
Apesar de opcional para o projeto, as receitas do Makefile ajudam a automatizar ou reduzir algumas sequências de comandos. No entando, é necessário ter o executável do GNU Make no sistema (provavelmente você já o tenha, cheque: $ make --version). Para obter informações sobre como instalar o GNU Make, clique aqui.

Se você está no Debian (ou Ubuntu), por exemplo, o processo de instalação é mais ou menos como isso:

# Ubuntu seria: apt-get install build-essential $ apt install make $ make --version GNU Make 4.1 Compilado para x86_64-pc-linux-gnu Copyright (C) 1988-2014 Free Software Foundation, Inc. ...

Uma vez que você se certificou que o make está instalado, você pode seguir para próxima seção e de fato instalar a aplicação e suas dependências.

Clonando e instalando as dependências específicas

A primeira coisa que você deve ter em mãos é o source-code do projeto. Se você não o recebeu como arquivo comprimido, então clone o repositório da seguinte URL:
https://github.com/felipsmartins/drf-reman

Clonando o repositório é a forma recomandada. Então as instruções são:

$ git clone https://github.com/felipsmartins/drf-reman $ cd fastsellerxt/ $ virtualenv --python=python2.7 virtualenv $ source virtualenv/bin/activate $ pip install -r requirements/prod.txt $ python manage.py migrate api

Uma vez que tudo está instalado, tudo que você precisa fazer agora é executar o built-in webserver e interagir com a API.

$ python manage.py runserver # ou use make, se tiver configurado $ make serve

Para onde ir agora?
Agora que temos a aplicação rodando, você pode consultar a seção específica para ela. Há uma página específica descrevendo os endpoints da API.

Gerando essa documentação

Essa seção é destinada para aqueles que querem editar ou construir a documentação a partir do source-code. Esses arquivos se encontram em sob o diretório docs/book. A documentação é construída com a ferramenta mkdocs e podemos instalá-la via pip.

Se você tem o make instalado e seu virtual environment está ativo, então:

$ make docs

ou manualmente:

$ pip install -r requirements/local.txt $ mkdocs build --clean