portainer-py

Installation

portainer-py is distributed on PyPI as a universal wheel and is available on Linux/macOS and Windows and supports Python 3.5+.

$ pip install portainer-py

Usage

From the command line

The only command currently supported is deploy. Use the help function to find out how to use it:

$ portainerpy deploy --help
Usage: portainerpy deploy [OPTIONS]

  Update and deploy a portainer stack.

  To ease automation, this utility also support using environment variables
  instead of using these command line options:

  --user       PORTAINER_USERNAME
  --password   PORTAINER_PASSWORD
  --host       PORTAINER_HOST
  --stackname  PORTAINER_STACK_NAME
  --stackfile  PORTAINER_STACKFILE

Options:
  -f, --stackfile PATH  Path to the stackfile.yml  [required]
  -h, --host TEXT       URL to Portainer host  [required]
  -u, --user TEXT       Portainer username  [required]
  -p, --password TEXT   Portainer password
  -n, --stackname TEXT  Name of the Portainer stack  [required]
  -e, --env TEXT        Environment variables to add to the stack
  --prune-env           If true, will remove existing environment variables
                        from the stack
  --prune-stack         Prune services that are no longer referenced
  --help                Show this message and exit.

From python

If you’re running Portainer locally, which should be very easy using Docker, connect to it like this:

from portainer_py import portainer_for_host

portainer = portainer_for_host("http://localhost:9000")
portainer.login("<username>", "<password>")

stack = portainer.stack_with_name("my-stack")

try:
    portainer.update_stack(
        stack["Id"],
        "path/to/stackfile.yml",
        env_vars={"foo": "bar"}
    )
except: PortainerError as error:
    print(error.message)

License

portainer-py is distributed under the terms of the MIT License.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

portainer-py-0.7.0.tar.gz (10.8 kB view details)

Uploaded Feb 7, 2019 Source

File details

Details for the file portainer-py-0.7.0.tar.gz.

File metadata

Download URL: portainer-py-0.7.0.tar.gz
Upload date: Feb 7, 2019
Size: 10.8 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.30.0 CPython/3.6.3

File hashes

Hashes for portainer-py-0.7.0.tar.gz
Algorithm	Hash digest
SHA256	`9abf2a7ba934ddc400287421271e660b25210447e508539e23e3e87579eb7a17`
MD5	`22744daddaa68c3b8b17bc335e4ae815`
BLAKE2b-256	`2791808ffbba07beea76386320ac59c25eda484568f798637ef59d6c76d501bf`