From d38ff896f6fc7017801b885c8266e55acaec2dc2 Mon Sep 17 00:00:00 2001 From: Arc <33088785+arcbtc@users.noreply.github.com> Date: Wed, 3 Aug 2022 08:55:20 +0100 Subject: [PATCH] update dev docs for internal testing before pushing (#801) --- docs/devs/extensions.md | 14 ++++++-------- docs/guide/installation.md | 2 -- 2 files changed, 6 insertions(+), 10 deletions(-) diff --git a/docs/devs/extensions.md b/docs/devs/extensions.md index 8c9a30a4..0bdbb060 100644 --- a/docs/devs/extensions.md +++ b/docs/devs/extensions.md @@ -28,17 +28,15 @@ Going over the example extension's structure: Adding new dependencies ----------------------- -If for some reason your extensions needs a new python package to work, you can add a new package using Pipenv: +If for some reason your extensions needs a new python package to work, you can add a new package using `venv`, or `poerty`: ```sh -$ pipenv install new_package_name +$ poetry add +# or +$ ./venv/bin/pip install ``` -This will create a new entry in the `Pipenv` file. **But we need an extra step to make sure LNbits doesn't break in production.** -All tests and deployments should run against the `requirements.txt` file so every time a new package is added -it is necessary to run the Pipenv `lock` command and manually update the requirements file: +Dependencies need to be added to `pyproject.toml` and `requirements.txt`, then tested by running on `venv` and `poetry`. +`nix` compatability can be tested with `nix build .#checks.x86_64-linux.vmTest`. -```sh -$ pipenv lock -r -``` diff --git a/docs/guide/installation.md b/docs/guide/installation.md index eb88bedd..b68d5cb3 100644 --- a/docs/guide/installation.md +++ b/docs/guide/installation.md @@ -4,8 +4,6 @@ title: Basic installation nav_order: 2 --- - - # Basic installation You can choose between four package managers, `poetry`, `nix` and `venv`.