Skip to main content

Python script & GUI to manage Octopus deploy servers through the Octopus Restful APIs

Project description



Python script and GUI to manage Octopus deploy servers through the Octopus Restful APIs

Why octopus-python-client?

This project programmatically manage Octopus server through Restful APIs by command line and GUI.


start Octopus python client GUI


macOS issue

command line example: get all configurations and settings from all spaces at

octopus_python_client -a=get_spaces

Get started

This section describes how to install and configure octopus-python-client.


To work with octopus-python-client, you need the following:


After you've cloned octopus-python-client, configure it by following these steps before installation

  • open src/octopus_python_client/configurations/configuration.json
  • change the endpoint, folder name; user_name and password or api_key is needed, not both


  • To install octopus-python-client, run
pip install octopus-python-client --upgrade

You need python3.6 and higher

  • To uninstall octopus-python-client, run
pip uninstall octopus-python-client

Run octopus-python-client


Code contributions and improvements by the community are welcomed! See the LICENSE file for current open-source licensing and use information.

Before we can accept pull requests from contributors, we require a signed Contributor License Agreement (CLA).

Project details

Download files

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

Source Distribution

octopus-python-client-2.9.6.tar.gz (52.4 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page