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.7.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 407877ca61b5eeefed6b72d51b87faec254a363facaac8286db10e95e5accb8a |
|
MD5 | 90323e1a42e9bb68aaedad9c361346bb |
|
BLAKE2b-256 | a419afdd20837fb03d72c79f3e83754115fcb19ef95d4396f98d66c55bd99ffb |
Hashes for octopus_python_client-2.7.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 38a124bd9714cdf10292b7a64c7c3d5229291df45110b70b95154774d840cf5f |
|
MD5 | 603a790f25ec391156869dc157eb7c7b |
|
BLAKE2b-256 | 6488e0ac0764c8dbb5bc161bc81d80769c66d77680de647c970e0ae7aa9f78a9 |