Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
clients
python
silkaj
Commits
e41e36fa
Commit
e41e36fa
authored
May 09, 2021
by
Moul
Browse files
[doc] Improve install_poetry doc
parent
921099c0
Changes
1
Hide whitespace changes
Inline
Side-by-side
doc/install_poetry.md
View file @
e41e36fa
...
...
@@ -18,10 +18,17 @@ sudo apt install libffi-dev # Required on ARMbian
pip3
install
poetry
--user
```
### Install dependencies and the Python environment
### Install dependencies and the Python
virtual
environment
```
bash
git clone https://git.duniter.org/clients/python/silkaj
# Over HTTPS
git clone https://git.duniter.org/clients/python/silkaj.git
# Over SSH
git clone git@git.duniter.org:clients/python/silkaj.git
cd
silkaj
# Installs the runtime and development dependencies
poetry
install
```
...
...
@@ -31,11 +38,24 @@ Within `silkaj` repository run Silkaj:
poetry run silkaj
```
You might need to enter Poetry shell to access development tools such as
`pytest`
or
`black`
.
### Poetry shell
You can access tools (
`pytest`
,
`black`
) from within the development environment with
`poetry run`
or by entering the shell:
```
bash
silkaj> poetry run pytest
silkaj> poetry run black
```
```
bash
silkaj> poetry shell
(
silkaj-58dUTebQ-py3.9
)
silkaj> black
(
silkaj-58dUTebQ-py3.9
)
silkaj> pytest
```
### Make Silkaj accessible from everywhere
Add following alias to your shell configuration:
```
bash
alias
silkaj
=
"cd /path/to/silkaj
/silkaj
&& poetry run silkaj"
alias
silkaj
=
"cd /path/to/silkaj && poetry run silkaj"
```
### Contribute
Follow the
[
contributing guide
](
CONTRIBUTING.md
)
.
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment