Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
silkaj
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Terraform modules
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
clients
python
silkaj
Commits
06cee474
Commit
06cee474
authored
5 years ago
by
Moul
Browse files
Options
Downloads
Patches
Plain Diff
[doc]
#182
: Document Poetry installation and usage
parent
0c113365
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
README.md
+1
-0
1 addition, 0 deletions
README.md
doc/install_poetry.md
+33
-0
33 additions, 0 deletions
doc/install_poetry.md
with
34 additions
and
0 deletions
README.md
+
1
−
0
View file @
06cee474
...
@@ -11,6 +11,7 @@ pip3 install silkaj --user
...
@@ -11,6 +11,7 @@ pip3 install silkaj --user
-
[
Install with Pip
](
doc/install_pip.md
)
-
[
Install with Pip
](
doc/install_pip.md
)
-
[
Install with pipenv
](
doc/install_pipenv.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 the build
](
doc/install_build.md
)
-
[
Install with docker
](
doc/install_docker.md
)
-
[
Install with docker
](
doc/install_docker.md
)
-
[
Build an executable with Pyinstaller
](
doc/build_with_pyinstaller.md
)
-
[
Build an executable with Pyinstaller
](
doc/build_with_pyinstaller.md
)
...
...
This diff is collapsed.
Click to expand it.
doc/install_poetry.md
0 → 100644
+
33
−
0
View file @
06cee474
## 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
"
$HOME
/silkaj/silkaj && poetry run silkaj"
```
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment