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 Distribution
Hashes for octopus-python-client-0.0.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 524bbb513a3f78838f9219b0826d4b44e8de8eb958b9ac8ce82fbe8e6aa6c618 |
|
MD5 | 7f4456ccf4bf2fd1470d123d5ab6b33d |
|
BLAKE2b-256 | 87fd4b251a48d634c9a3bd14a2a9492dddd845c77f3ca4b9bf04f7f76dbf8292 |
Hashes for octopus_python_client-0.0.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 84b12cb353a183a7dd2473cd3bbb67d095ca512010fcc28e2f0d514f8182135a |
|
MD5 | fc14eff7001533f2a7f31838949a99a0 |
|
BLAKE2b-256 | 77d218ce1ac95ede6143b9d48d99debdb9d346f60f7dc4a7dceea7411a18865b |