CONTRIBUTING.md

Contribua

Clone o projeto repositório

git clone https://github.com/imobanco/ZoopAPIWrapper.git

Setup env & data folder

run command to config .env file and data folder

make config

Or

make config.data
make config.env

Docker + docker-compose

Install docker-ce and docker-compose from each documentation.

Running using Docker (development)

First build a image named zoopapiwrapper.

docker build --tag zoopapiwrapper .

Running in development:

docker run -it \
--rm \
--env-file .env \
--volume "$(pwd)":/code \
--workdir /code \
zoopapiwrapper \
bash

Running using Docker Compose (development)

First build:

docker-compose build

For development use:

docker-compose run zoopapiwrapper bash

Note: the above command uses run, for development it is really handy.

Bare python

requires python>=3.6

config virtual env for python with your python version

python3.6 -m venv env

Active env

on project folder run

source env/bin/activate

Install libs

on project folder and with env active

make pip.install

Running tests

on project folder and with env active

make test