Python script to manage Octopus deploy servers through the Octopus Restful APIs
Project description
octopus-python-client
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.
- Managing Octopus server through 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
Example
get all configurations and settings for Sapces-22 of https://demo.octopusdeploy.com/api/
octopus_python_client -a=get_all -s=Spaces-22
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 Distributions
Hashes for octopus-python-client-1.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ef6efbabad056dc3c1fe77d4093fa508aec068a02a8748454aca45cbf7615432 |
|
MD5 | 8ee78f6abbb1c5064a9e9d9fb23a8b3d |
|
BLAKE2b-256 | 589921786a33d44baee099911e2b4ea033577b5ca5d733d7044536ddaa7cc6ed |
Hashes for octopus_python_client-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 583424ec01001fdf367a83aeb72cdaadf91ea9d8172abfcad6feb55d20259451 |
|
MD5 | fe901ed235e2950a2c4c03f782ad543d |
|
BLAKE2b-256 | c79529790f8cfffa5687089181e3f4acf9e2df49feaaf5068ca283a6d6159162 |
Hashes for octopus_python_client-1.0.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c965661df2e2be57c6106bc74011755db22857d892d9ba817c7861dc364c8acc |
|
MD5 | 376df651bc1c69dd77f74d9e788e02ff |
|
BLAKE2b-256 | a613a1d92ffb460fa9792c1dbe37293ca0aec6f17267758ebfd412f13a3719b6 |