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 from all spaces at https://demo.octopusdeploy.com/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-1.1.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 235080ad60181f2d1225d75ef579a0cb66525f0cb8929ac9c6fc11f5e5dfa1bc |
|
MD5 | fdfb55cb4b3ee7688bfd60dee88d1a64 |
|
BLAKE2b-256 | 365aa48468a87b9892cf0b2c9701e8e131749d1b8c94c07cdf18363d420d1b55 |
Hashes for octopus_python_client-1.1.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a71b67a77c6c6ada4220bbc204e9de91209d635c7030e49a30347b68378cf1dd |
|
MD5 | 8784cb56d80886250e03bfe120410fe7 |
|
BLAKE2b-256 | eb2cc75d19f6d0c3b4c74b028e71ea4eccecf48f3bb23d68b64a08af7843f445 |