Skip to main content
Python Software Foundation 20th Year Anniversary Fundraiser  Donate today!

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

Project description

octopus-python-client

As-Is

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.

Example

start Octopus python client GUI

octopus_python_client_gui

macOS issue

command line example: get all configurations and settings from all spaces at https://samples.octopus.app/api/

octopus_python_client -a=get_spaces

Get started

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

Prerequistes

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

Configuration

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

Installation

  • 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

Contributions

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 2.9.6
Filename, size File type Python version Upload date Hashes
Filename, size octopus_python_client-2.9.6-py3-none-any.whl (62.0 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size octopus-python-client-2.9.6.tar.gz (52.4 kB) File type Source Python version None Upload date Hashes View

Supported by

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