Skip to content

Commit

Permalink
Update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
containerscrew committed Jun 4, 2024
1 parent 47e576b commit fdebe22
Showing 1 changed file with 66 additions and 0 deletions.
66 changes: 66 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@
- [Available tools](#available-tools)
- [Versioning](#versioning)
- [Dynamically change terraform version](#dynamically-change-terraform-version)
- [Installing python libraries](#installing-python-libraries)
- [Use pipx to install python packages/libraries](#use-pipx-to-install-python-packageslibraries)
- [Use venv](#use-venv)
- [Force installation](#force-installation)
- [Architecture](#architecture)
- [Image security scan with Trivy](#image-security-scan-with-trivy)
- [Local trivy scan](#local-trivy-scan)
Expand Down Expand Up @@ -75,6 +79,68 @@ Or change it yourself, for example, within a pipeline:
tfenv use 1.5.5
```

## Installing python libraries

You can install python libraries using `pip3`. BTW, you will see the following error:

```
× This environment is externally managed
╰─>
The system-wide python installation should be maintained using the system
package manager (apk) only.
If the package in question is not packaged already (and hence installable via
"apk add py3-somepackage"), please consider installing it inside a virtual
environment, e.g.:
python3 -m venv /path/to/venv
. /path/to/venv/bin/activate
pip install mypackage
To exit the virtual environment, run:
deactivate
The virtual environment is not deleted, and can be re-entered by re-sourcing
the activate file.
To automatically manage virtual environments, consider using pipx (from the
pipx package).
note: If you believe this is a mistake, please contact your Python installation or OS distribution provider. You can override this, at the risk of breaking your Python installation or OS, by passing --break-system-packages.
hint: See PEP 668 for the detailed specification.
```

### Use pipx to install python packages/libraries

Install library + deps:

```shell
pipx install boto3 --include-deps
```

Install a package:

```shell
pipx install your-package-name # visit pypip
```

### Use venv

```shell
python3 -m venv /path/to/venv
. /path/to/venv/bin/activate
pip3 install mypackage
```

### Force installation

```shell
pip3 install boto3 --break-system-packages
```



# Architecture

| Arch | Supported | Tested |
Expand Down

0 comments on commit fdebe22

Please sign in to comment.