From 2f41a4aa360c06e5c7a24176b0136b1ee49d1055 Mon Sep 17 00:00:00 2001 From: Daniel Palomar <danypr92@gmail.com> Date: Tue, 31 May 2022 13:50:08 +0200 Subject: [PATCH] Add documentation to setup development environment --- .python-version | 1 + README.md | 19 +++++++++++++++++++ requirements-dev.txt | 2 ++ 3 files changed, 22 insertions(+) create mode 100644 .python-version diff --git a/.python-version b/.python-version new file mode 100644 index 0000000..2e62655 --- /dev/null +++ b/.python-version @@ -0,0 +1 @@ +odoo-somconnexio-python-client diff --git a/README.md b/README.md index 41e06bb..00885a0 100644 --- a/README.md +++ b/README.md @@ -163,6 +163,25 @@ Create a class that expose a dict objecti with the next structure: ## Development +### Setup environment + +1. Install `pyenv` +```sh +curl https://pyenv.run | bash +``` +2. Build the Python version +```sh +pyenv install 3.8.13 +``` +3. Create a virtualenv +```sh +pyenv virtualenv 3.8.13 odoo-somconnexio-python-client +``` +4. Install dependencies +```sh +pyenv exec pip install -r requirements-dev.txt +``` + ### Test the HTTP request We are using the HTTP recording plugin of Pytest: [pytest-recording](https://pytest-vcr.readthedocs.io/). diff --git a/requirements-dev.txt b/requirements-dev.txt index db56f4d..26e7c0c 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -1,3 +1,5 @@ +tox==3.25.0 +requests==2.27.1 mock==4.0.3 unittest2==1.1.0 pytest==6.2.5 -- GitLab