CONTRIBUTING.md

Contributing

This project is based on Geronimo-iaa's Python Template. This is a cookiecutter template for a typical Python library following modern packaging conventions. It utilizes popular libraries to fully automate all development and deployment tasks.

Setup

Requirements

You will need:

• Python 3.8"+
• Pyenv
• poetry
• Make with find, sed

Make Installation

A powerfull tool:

• macOS: $ xcode-select --install
• Linux: https://www.gnu.org/software/make
• Windows: https://mingw.org/download/installer

Pyenv Installation

Pyenv will manage all our python version. Follow https://github.com/pyenv/pyenv#installation

Python Installation

Do:

$ pyenv install 3.8

Note for MacOS 10.14 user:

  SDKROOT=/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX10.14.sdk MACOSX_DEPLOYMENT_TARGET=10.14 pyenv install 3.8

Poetry Installation: https://poetry.eustace.io/docs/#installation

Poetry will manage our dependencies and create our virtual environment for us.

Integration With Visual Studio Code

Even if we use fabulous tool like pyenv, poetry, ... at the end, we just want to go on, and code.

So here, few detail of my installation.

• .bashrc

  # init pyenv with default python version
  if command -v pyenv 1>/dev/null 2>&1; then
  eval "$(pyenv init -)"
  fi
  
  # add poetry in path
  export PATH="$HOME/.poetry/bin:$PATH"
  
  # Add Visual Studio Code (code)
  export PATH="$PATH:/Applications/Visual Studio Code.app/Contents/Resources/app/bin"

• poetry configuration: all is let with default

• How Launch Visual Studio Code within virtual environment created by poetry ? After do a make install, you have to do:

  poetry shell
  code .

  poetry shell will activate project virtual environment.

Make Target list

Name	Comment
debug-info	Show poetry debug info
install	Install project dependencies
check	Run linters and static analysis
test	Run unit tests
build	Builds the source and wheels archives
build-docs	Builds site documentation.
publish	Publishes the package, previously built with the build command, to the remote repository
publish-docs	Build and publish site documentation.
clean	Delete all generated and temporary files