Python script to manage Octopus deploy servers through the Octopus Restful APIs
Project description
octopus-python-client
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.
- Managing Octopus server through Octopus UI does not fit all situations.
- In the market, we have only PowerShell and C# client tools to manage Octopus server through APIs. We want a client tool which is across the different platform/OS to manage Octopus server through APIs.
- A Octopus server/space migration tool is missing on the market. See the complaints https://github.com/OctopusDeploy/Issues/issues/5451 https://help.octopus.com/t/how-do-i-transfer-or-clone-a-project-to-a-different-space-in-octopus-cloud/23333 https://help.octopus.com/t/octopus-migration-import-api-does-not-honor-space-id/24287/4
- An Octopus client tool with GUI is not available
Example
start Octopus python client GUI
octopus_python_client
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:
- Windows, MacOS, Linux
- requests >= 2.20.0
- PyYAML>=5.1
- python >= 3.6
Configuration
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
Installation
- 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
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for octopus-python-client-2.3.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0512fd5e7426231617ecd7b7c3e8669263102ae51531d85f1ad5e640bb3cbfda |
|
MD5 | a5794ac69008c0e9268dc31ed0c97af3 |
|
BLAKE2b-256 | 5aead9645eddc850b278c907adc0fdd2bdce3e29ae43c68e26f565318daf5408 |
Hashes for octopus_python_client-2.3.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 90e033363293baa9d351e26bd32884d8d6d8556bfed82f1d7f829caa1de75e53 |
|
MD5 | 8b743f5c7731a3f75bb6d5609dc70327 |
|
BLAKE2b-256 | ce854194e40d6533e54d104f294b86eb3b92993d31a1452e2e525f15c3637070 |