heierbtc/lnbits
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update dev docs for internal testing before pushing (#801)

Browse Source
This commit is contained in:
Arc 2022-08-03 08:55:20 +01:00 committed by GitHub
parent 28af0a2100
commit d38ff896f6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 6 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/devs/extensions.md
View File

@ -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 <package>
# or
$ ./venv/bin/pip install <package>
```
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
```

2
docs/guide/installation.md
View File

@ -4,8 +4,6 @@ title: Basic installation
nav_order: 2
---
# Basic installation
You can choose between four package managers, `poetry`, `nix` and `venv`.