patch: work around pip's secure-install bug; bump version

- upstream issue: https://github.com/pypa/pip/issues/9644
- runs tests within a container, uses the same `dockerfile`
- ignores `pdm.lock`, removes `requirement.txt`
- update manual contribution steps
- bumps project version

**Related Items**

_Issues_

- Closes #137
This commit is contained in:
Jovial Joe Jayarson
2023-07-19 17:49:49 +05:30
parent 78ac94ef4f
commit 9630bc0a2b
9 changed files with 69 additions and 1095 deletions

View File

@@ -4,7 +4,7 @@
> First off, thank you! Please follow along.
**You need to _`fork`_ this repository and _`clone`_ it onto your system.** Inside the cloned folder, create a `.env` file with the following contents (without `# comments`):
**You need to _`fork`_ this repository & _`clone`_ it onto your system.** Inside the cloned folder, create a `.env` file with the following contents (without `# comments`):
```ini
INPUT_GH_TOKEN=EXAMPLE_GITHUB_PAT # required (for development)
@@ -44,26 +44,23 @@ $ podman-compose -p waka-readme -f ./docker-compose.yml down
## Using virtual environments
> Assumes you've already installed & configured latest version of [python](https://www.python.org/) and [pdm](https://pdm.fming.dev/latest/).
> Assumes you've already installed & configured latest version of [python](https://www.python.org/).
1. Inside the cloned folder run the following commands to install dependencies
```console
$ pdm install
$ eval $(pdm venv activate)
$ python -m venv .venv
$ . ./.venv/bin/activate
$ python -m pip install .
```
in a virtual environnement and activate it. In windows use the following
```ps1
> Invoke-Expression (pdm venv activate)
```
to activate virtual environment.
to activate virtual environment & install dependencies.
2. To test or execute the program in development, run:
```console
(waka-readme-py3_11)$ python -m unittest discover # run tests
(waka-readme-py3_11)$ python -m main --dev # execute program in dev mode
(.venv)$ python -m unittest discover # run tests
(.venv)$ python -m main --dev # execute program in dev mode
```
> You can use any other virtual environment & dependency manager as well.