mirror of
https://github.com/lnbits/lnbits-legend.git
synced 2025-02-22 22:25:47 +01:00
update dev docs for internal testing before pushing (#801)
This commit is contained in:
parent
28af0a2100
commit
d38ff896f6
2 changed files with 6 additions and 10 deletions
|
@ -28,17 +28,15 @@ Going over the example extension's structure:
|
||||||
Adding new dependencies
|
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
|
```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.**
|
**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
|
Dependencies need to be added to `pyproject.toml` and `requirements.txt`, then tested by running on `venv` and `poetry`.
|
||||||
it is necessary to run the Pipenv `lock` command and manually update the requirements file:
|
`nix` compatability can be tested with `nix build .#checks.x86_64-linux.vmTest`.
|
||||||
|
|
||||||
```sh
|
|
||||||
$ pipenv lock -r
|
|
||||||
```
|
|
||||||
|
|
|
@ -4,8 +4,6 @@ title: Basic installation
|
||||||
nav_order: 2
|
nav_order: 2
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# Basic installation
|
# Basic installation
|
||||||
|
|
||||||
You can choose between four package managers, `poetry`, `nix` and `venv`.
|
You can choose between four package managers, `poetry`, `nix` and `venv`.
|
||||||
|
|
Loading…
Add table
Reference in a new issue