the-liberated-edge/test_linux_containers
2
0
Fork 0
generated from the-liberated-edge/wikijs
Code Issues 5 Pull Requests Packages Projects 1 Releases Wiki Activity

i-15 Automate project initialisation (#16)

Browse Source 
# 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:
emil 2024-03-04 22:36:51 +00:00
parent 9dec516467
commit 7d6f05e201
2 changed files with 17 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -147,17 +147,23 @@ git clone \
cd test_linux_containers cd test_linux_containers
``` ```
``` Prior to any further development one needs to initialise the project by running
pipenv install the following commands on the command line.
```
``` ```
pipenv install --dev task init-project pipenv-shell
``` ```
``` These tasks will perform the following steps.
pipenv shell
``` 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 ## Lint Ansible artifacts

4
Taskfile.yml
View File

@ -1,6 +1,10 @@
--- ---
version: '3' version: '3'
tasks: tasks:
init-project:
cmds: [pipenv install, pipenv install --dev]
pipenv-shell:
cmds: [pipenv shell]
format-yml: format-yml:
cmds: [yamlfix .] cmds: [yamlfix .]
lint-yml: lint-yml: