Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
What's new
7
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Open sidebar
matograine
silkaj
Commits
e5741872
Commit
e5741872
authored
Jun 08, 2019
by
Moul
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
[doc]
#182
: Document Poetry installation and usage
parent
957a03dd
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
34 additions
and
0 deletions
+34
-0
README.md
README.md
+1
-0
doc/install_poetry.md
doc/install_poetry.md
+33
-0
No files found.
README.md
View file @
e5741872
...
...
@@ -11,6 +11,7 @@ pip3 install silkaj --user
-
[
Install with Pip
](
doc/install_pip.md
)
-
[
Install with pipenv
](
doc/install_pipenv.md
)
-
[
Install the Development environment
](
doc/install_poetry.md
)
-
[
Install with the build
](
doc/install_build.md
)
-
[
Install with docker
](
doc/install_docker.md
)
-
[
Build an executable with Pyinstaller
](
doc/build_with_pyinstaller.md
)
...
...
doc/install_poetry.md
0 → 100644
View file @
e5741872
## Install Silkaj in a development environement with Poetry
### Install libsodium
```
bash
sudo
apt
install
libsodium23
# Debian Buster
sudo
apt
install
libsodium18
# Debian Stretch
sudo
dnf
install
libsodium
# Fedora
```
### Install Poetry
-
[
Installation documentation
](
https://poetry.eustace.io/docs/#installation
)
### Install dependencies and the Python environment
```
bash
poetry
install
```
### Run Silkaj
Within
`silkaj`
repository, enter the development environement and run Silkaj:
```
bash
poetry shell
./bin/silkaj
```
You might need to enter Poetry shell to access development tools such as
`pytest`
or
`black`
.
### Make Silkaj accessible from everywhere
Add following alias to your shell configuration:
```
bash
alias
silkaj
=
"cd /path/to/silkaj/silkaj && poetry run silkaj"
```
Write
Preview
Markdown
is supported
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