generated from the-liberated-edge/wikijs
i-15 Automate project initialisation (#16)
# Context This PR implements the following [issue](#15). # Acceptance criteria - [x] A task for project initialisation that eventually switches to a newly created Python virtual environment has been introduced. - [x] `README.md` has been updated to reflect the changes. Co-authored-by: emo <esimeonov@gmail.com> Reviewed-on: #16
This commit is contained in:
parent
9dec516467
commit
7d6f05e201
20
README.md
20
README.md
@ -147,17 +147,23 @@ git clone \
|
||||
cd test_linux_containers
|
||||
```
|
||||
|
||||
```
|
||||
pipenv install
|
||||
```
|
||||
Prior to any further development one needs to initialise the project by running
|
||||
the following commands on the command line.
|
||||
|
||||
```
|
||||
pipenv install --dev
|
||||
task init-project pipenv-shell
|
||||
```
|
||||
|
||||
```
|
||||
pipenv shell
|
||||
```
|
||||
These tasks will perform the following steps.
|
||||
|
||||
1. Create a Python virtual environment through `pipenv`.
|
||||
2. Any Python dependencies described in `Pipfile.lock`, such as Ansible,
|
||||
will be downloaded and installed.
|
||||
3. Any Python development dependencies described in `Pipfile.lock`,
|
||||
such as linters and code formatters, will be downloaded and installed.
|
||||
4. The virtual environment will be activated.
|
||||
|
||||
From this point on, the project is properly initialised for development.
|
||||
|
||||
## Lint Ansible artifacts
|
||||
|
||||
|
||||
@ -1,6 +1,10 @@
|
||||
---
|
||||
version: '3'
|
||||
tasks:
|
||||
init-project:
|
||||
cmds: [pipenv install, pipenv install --dev]
|
||||
pipenv-shell:
|
||||
cmds: [pipenv shell]
|
||||
format-yml:
|
||||
cmds: [yamlfix .]
|
||||
lint-yml:
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user