README.md

PROJECT NAME

Project description

Summary

• Getting Started
• Prerequisites
• Installing
  • Configuration
  • Docker compose usage
  • Dependencies install
  • Data import
  • Source files
• Environment
  • Code quality
• Python commands usage
• Running the tests
  • Unit testing
  • End to end tests testing
• Delivery
• Deployment
  • Test environment
  • Production environment
• Built With
• Versioning

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system. You can plug any of this tools to your favourite IDE.

Prerequisites

You need to have the following softwares installed on your local machine:

• Python library
  • local
  • from a Docker container
• pip (already installed if you are using Python 2 >=2.7.9 or Python 3 >=3.4))

Windows

• Docker for windows
• Visual C++ Build Tools

Microsoft Visual C++ 14.0 (2015) with C++ Build Tools is required before installing pip. Note that while the error is calling for vc++ 14.0 - everything will work with newer versions of visual C++.

Installing

Clone project using ssh (you will need to set a SSH key in your Gitlab profile)

git clone [email protected]

Configuration

• Each ./Dockerfile contains a basic configuration for developing with Python and deploying in a production environment
• The file .env allows to set the name of the Docker project's stack as well as basic Python image version for Docker
• The file .env.dev.local must be created (and git ignored) to fill in empty parameters from the /.env file

Docker compose usage

• Run / init: docker-compose up
• Stop: docker-compose stop
• Destroy: docker-compose down
• Cleanup: docker-compose rm -vsf
• Reset: docker system prune -af --volumes

Dependencies install

When starting the backend container, pip will download and install dependencies in the dedicated directory

Data import

We use name and link to the SGBDR documentation for this project.

Explain how to import data when you start working on this project

Source files

Explain where your source code is located

Environment

Code quality

We use code quality tools which you can plug in your favourite IDE:

List which code quality tools are used and mandatory in this project For each tool: name, link to documentation and path to the associated config file

Python commands usage

Use this pattern

docker-compose exec backend <entrypoint> <command> <args>

Running the tests

Unit testing

Launch tests with associated config file in `` Path to the test config file

docker-compose exec backend <entrypoint> <command> <args>

End to end tests testing

Launch tests with associated config file in `` path to the test config file

docker-compose exec backend <entrypoint> <command> <args>

Delivery

Explain how do you deliver the project to the client

Deployment

Test environment

Explain how do you deploy in test environment

Production environment

Explain how do you deploy in production environment

Built With

List which code and test frameworks and libraries are used in this project For each one: name and link to documentation

• Docker - Virtualization and container management

Versioning

We use Git and Gitflow with conventional commits for versioning.