Skip to main content

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

Project description



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

Why octopus-python-client?

This project programmatically manage Octopus server through Restful APIs.


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.jason
  • change the endpoint, folder name; user_name and password or api_key is needed, not both


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

Run octopus-python-client

Please check the wiki for more details


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.

Files for octopus-python-client, version 1.3.3
Filename, size File type Python version Upload date Hashes
Filename, size octopus_python_client-1.3.3-py3-none-any.whl (33.4 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size octopus-python-client-1.3.3.tar.gz (29.8 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page