Python script and GUI to manage Octopus deploy servers through the Octopus Restful APIs
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 OctopusDeploy/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
start Octopus python client GUI
octopus_python_client_gui
command line example: get all configurations and settings from all spaces at https://samples.octopus.app/api/
octopus_python_client -a=get_spaces
This section describes how to install and configure octopus-python-client.
To work with octopus-python-client, you need the following:
- Windows, macOS, Linux
- requests >= 2.20.0
- PyYAML>=5.1
- python >= 3.6
After you've cloned octopus-python-client, configure it by following these steps before installation
- open src/octopus_python_client/configurations/configuration.json
- change the endpoint, folder name; user_name and password or api_key is needed, not both
- To install octopus-python-client, run
pip install octopus-python-client --upgrade
You need python3.6 and higher
- To uninstall octopus-python-client, run
pip uninstall octopus-python-client
- Please check the wiki for more details
- PYPI Octopus-python-client
- Video instructions on YouTube
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).
