mirror of
https://github.com/aljazceru/breez-sdk-docs.git
synced 2025-12-17 13:54:20 +01:00
Add README.md
This commit is contained in:
27
snippets/python_snippets/README.md
Normal file
27
snippets/python_snippets/README.md
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
## Steps to run locally
|
||||||
|
|
||||||
|
To check the syntax:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd snippets/python_snippets
|
||||||
|
python3 -m compileall src
|
||||||
|
```
|
||||||
|
|
||||||
|
To check the snippet formatting:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd snippets/python_snippets/src
|
||||||
|
ruff --ignore F841 --ignore F401 --output-format=github .
|
||||||
|
```
|
||||||
|
|
||||||
|
To execute the snippets locally, in order to check for type correctness:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
export API_KEY="..."
|
||||||
|
export MNEMONIC="..."
|
||||||
|
|
||||||
|
cd snippets/python_snippets
|
||||||
|
python main.py $API_KEY $MNEMONIC
|
||||||
|
```
|
||||||
Reference in New Issue
Block a user