From fe9a9e0aba893bb6dc1beece9e6c8ff100d04cc0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sybren=20A=2E=20St=C3=BCvel?= Date: Fri, 10 May 2019 15:07:38 +0200 Subject: [PATCH] README+CHANGELOG: documented use of Poetry --- CHANGELOG.md | 1 + README.md | 6 ++++-- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d876a707..68dd99c0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,7 @@ Flamenco Server Changelog - Re-queueing a task erases the `failed_by_workers` list, so that workers that previously failed the task can try again. This is essential when the task was failing due to external conditions,m for example failure due to a crash that was fixed by upgrading Blender. +- Switched to [Poetry](https://poetry.eustace.io/) for dependency management. ## Version 2.2 (released 2019-03-25) diff --git a/README.md b/README.md index aa119601..9b22f326 100644 --- a/README.md +++ b/README.md @@ -5,10 +5,12 @@ Documentation can be found at https://flamenco.io/docs/. ## Development Setup +Dependencies are managed via [Poetry](https://poetry.eustace.io/). Install it using +`pip install -U --user poetry`. + In order to get Flamenco up and running for development, we need to follow these steps: -- Install requirements with `pip install -r requirements-dev.txt` -- Install Flamenco Server locally with `pip install -e .` +- Install requirements in a Python virtualenv with `poetry install` - Add Flamenco as Pillar extension to our project - Give a user 'subscriber' or 'demo' role to obtain flamenco-use capability, or set up your own mapping from role to `flamenco-use` and `flamenco-view` capabilities