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_gui
command line example: 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.json
- 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 octopus-python-client --upgrade
You need python3.6 and higher
- To uninstall octopus-python-client, run
pip uninstall octopus-python-client
Run octopus-python-client
- Please check the wiki for more details
- PYPI Octopus-python-client
- Video instructions on YouTube
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).
1 maintainer
Metadata
1 maintainer
Release files for octopus-python-client 2.9.6
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| octopus-python-client-2.9.6.tar.gz | 52.4 kB | Without provenance | Details for octopus-python-client-2.9.6.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| octopus_python_client-2.9.6-py3-none-any.whl | Python 3 | none | any | Details for octopus_python_client-2.9.6-py3-none-any.whl |
Total release size: 114.4 kB
Release files / octopus-python-client-2.9.6.tar.gz
| Download URL | octopus-python-client-2.9.6.tar.gz |
|---|---|
| Size | 52.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f9c8dff97e468bc65ddae107006c8ff9648931f1b5a66089fe9e6c36202ac8ff
|
|
BLAKE2b-256 checksum How to use checksums |
7b52878d96be9878fd159c4940d5371c31ba45ee7aca22ff11108afd7fd7af30
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.24.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.3
|
Release files / octopus_python_client-2.9.6-py3-none-any.whl
| Download URL | octopus_python_client-2.9.6-py3-none-any.whl |
|---|---|
| Size | 62.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8c5c0d769c88a0593d87067b2de081d2a79ae97d5deebb08816308df10342d3f
|
|
BLAKE2b-256 checksum How to use checksums |
d28f0a00c0c214d26c2e75cefbda9d1fe25c311220dec4c655fe43db800f76eb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.24.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.3
|
Security for octopus-python-client 2.9.6
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
