A Python restful-api sample.

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. If you prefer, you can also use Docker to get your copy running.

• Linux
• Python 3+
• Pip3
• Virtualenvwrapper (optional but recommended)
• PostgreSQL 10+

• Docker CE
• docker-compose

Installing requirements

$ sudo apt-get install redis-server
$ git clone git@github.com:antunesleo/manotes-api.git
$ mkvirtualenv manotes-api (Optional)
$ workon manotes-api (Optional)
$ pip install -r requirements.txt
$ pip install -r requirements_dev.txt

Dealing with environments variables

$ cd
$ vim .bashrc

Add this in the end of file and reopen the terminal
alias load-env='export $(cat .env | xargs)'
alias load-env-test='export $(cat .env.test | xargs)'

$ load-env

Setting up database

$ sudo apt-get install postgres
$ sudo su postgres
$ psql
$ CREATE ROLE manotes SUPERUSER LOGIN PASSWORD 'manotes'
$ CREATE DATABASE manotes
$ ALTER DATABASE manotes OWNER TO manotes;
$ \q
$ exit

Create a .env file based on .env.sample, with your custom configuration (if necessary) and then:
$ load-env
$ python manage.py db upgrade

Configuring tests coverage

sudo vim .coveralls.yml

repo_token: <repo_token>
service_name: manotes

load-env-test
python -m testtools.run

coverage run --omit=<path_to_envs>/* -m testtools.run
coveralls

load-env
python run.py

Preparing the Environment Variables

$ cp .env.sample.docker .env

You can also copy using your file browser, if you prefer.

Change the default configurations, as TEMP_FILE_PATH or TEMP_PATH to your project home path.

$ docker-compose up --build -d
$ docker-compose exec web bash
# python manage.py db upgrade

The last command will run the migrations

This will also take your project running!

$ docker-compose up -d
$ docker-copose exec web bash

This will take you inside the Web Container Bash.

$ python -m testtools.run

$ docker-compose up -d
$ docker-compose exec web bash

This will take you inside the Web Container Bash.

coverage run --omit=<path_to_envs>/* -m testtools.run
coveralls

$ docker-compose up -d

• Alembic - lightweight database migration tool for usage with the SQLAlchemy Database Toolkit
• boto3 - AWS SDK for Python, which allows Python developers to write software that makes use of services like S3.
• celery - Distributed task queue
• coveralls - Python interface to coveralls.io API
• coverage - Code coverage measurement for Python
• Flask - The web framework used
• flask-CORS - A Flask extension for handling Cross Origin Resource Sharing (CORS), making cross-origin AJAX possible.
• Flask Migrate - an extension that handles SQLAlchemy database migrations for Flask applications using Alembic.
• Flask-RESTful - an extension for Flask that adds support for quickly building REST APIs
• gunicorn - a Python WSGI HTTP Server for UNIX
• mock - mock is a library for testing in Python. It allows you to replace parts of your system under test with mock objects and make assertions about how they have been used.
• passlib - comprehensive password hashing framework
• pip - Dependency Management
• Psycopg - PostgreSQL adapter for the Python programming language
• SQLAlchemy - Python SQL toolkit and Object Relational Mapper
• SQLAlchemy-Utils - Various utility functions for SQLAlchemy.
• testtools - testtools is a set of extensions to Python’s standard unittest module.

• Leonardo Antunes - Initial work - antunesleo
• Pedro Pozzi Ferreira - Dockerization and Packages Update - PozziSan

See also the list of contributors who participated in this project.

This project is licensed under the MIT License - see the LICENSE.md file for details

pass