update: bump python_helpers to 1.3.0 or later to use Docker environment file loader.
This commit is contained in:
@@ -7,7 +7,8 @@ Licensed under the [MIT License](LICENSE).
|
||||
## Installation
|
||||
|
||||
The `miab` command is installed into the active virtual environment by any of the methods below.
|
||||
The package depends on `cloud-tools`, which provides the `python_helpers` package.
|
||||
The package depends on `cloud-tools` 1.3.0 or later, which provides the `python_helpers`
|
||||
package.
|
||||
|
||||
### Local install
|
||||
|
||||
@@ -98,8 +99,9 @@ The hostname is parsed out of `MAILINABOX_BASE_URL` when `MIAB_HOST` is not set.
|
||||
|
||||
### Environment file
|
||||
|
||||
`--env-file|-E` reads the same variables from a docker-style file, overriding any inherited
|
||||
from the shell. It is a global option and goes before the command name:
|
||||
`--env-file|-E` reads the same variables from a file in `docker run --env-file` syntax,
|
||||
overriding any inherited from the shell. It is a global option and goes before the command
|
||||
name:
|
||||
|
||||
```sh
|
||||
miab --env-file box.env list --type TXT
|
||||
@@ -112,16 +114,7 @@ MIAB_USERNAME=admin@example.com
|
||||
MIAB_PASSWORD=password
|
||||
```
|
||||
|
||||
Blank lines and lines whose first non-blank character is `#` are ignored; every other line must
|
||||
be `NAME=VALUE`. Values are taken literally, as `docker run --env-file` does: quotes are kept
|
||||
rather than stripped, `#` after the `=` is part of the value, and no variable interpolation is
|
||||
performed.
|
||||
|
||||
## Tests
|
||||
|
||||
```sh
|
||||
python3 -m unittest discover -s tests
|
||||
```
|
||||
Parsing is done by `python_helpers.env.load_env_file`, which documents the full syntax.
|
||||
|
||||
## AI Disclaimer
|
||||
|
||||
|
||||
Reference in New Issue
Block a user