Introduction
shade is a simple client library for interacting with OpenStack clouds. The key word here is simple. Clouds can do many many many things - but there are probably only about 10 of them that most people care about with any regularity. If you want to do complicated things, you should probably use the lower level client libraries - or even the REST API directly. However, if what you want is to be able to write an application that talks to clouds no matter what crazy choices the deployer has made in an attempt to be more hipster than their self-entitled narcissist peers, then shade is for you.
shade started its life as some code inside of ansible. ansible has a bunch of different OpenStack related modules, and there was a ton of duplicated code. Eventually, between refactoring that duplication into an internal library, and adding logic and features that the OpenStack Infra team had developed to run client applications at scale, it turned out that we’d written nine-tenths of what we’d need to have a standalone library.
Example
Sometimes an example is nice.
Create a clouds.yml file:
clouds: mordred: region_name: RegionOne auth: username: 'mordred' password: XXXXXXX project_name: 'shade' auth_url: 'https://montytaylor-sjc.openstack.blueboxgrid.com:5001/v2.0'Please note: os-client-config will look for a file called clouds.yaml in the following locations:
Current Directory
~/.config/openstack
/etc/openstack
More information at https://pypi.org/project/os-client-config
Create a server with shade, configured with the clouds.yml file:
import shade # Initialize and turn on debug logging shade.simple_logging(debug=True) # Initialize cloud # Cloud configs are read with os-client-config cloud = shade.openstack_cloud(cloud='mordred') # Upload an image to the cloud image = cloud.create_image( 'ubuntu-trusty', filename='ubuntu-trusty.qcow2', wait=True) # Find a flavor with at least 512M of RAM flavor = cloud.get_flavor_by_ram(512) # Boot a server, wait for it to boot, and then do whatever is needed # to get a public ip for it. cloud.create_server( 'my-server', image=image, flavor=flavor, wait=True, auto_ip=True)
Links
Metadata
Release files for shade 1.33.0
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 | |
|---|---|---|---|---|
| shade-1.33.0.tar.gz | 333.1 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| shade-1.33.0-py2.py3-none-any.whl | Python 2, Python 3 | none | any | Details |
Total release size: 706.6 kB
Release files / shade-1.33.0.tar.gz
| Download URL | shade-1.33.0.tar.gz |
|---|---|
| Size | 333.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
36f6936da93723f34bf99d00bae24aa4cc36125d597392ead8319720035d21e8
|
|
BLAKE2b-256 checksum How to use checksums |
b0a6a83f14eca6f7223319d9d564030bd322ca52c910c34943f38a59ad2a6549
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.5.2
|
Release files / shade-1.33.0-py2.py3-none-any.whl
| Download URL | shade-1.33.0-py2.py3-none-any.whl |
|---|---|
| Size | 373.5 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
88c3ae7e3fd29d309c0f414a80921de113a338ed37edbe175b987593396029e8
|
|
BLAKE2b-256 checksum How to use checksums |
f6dc9870d73a70f30429734298e3667da955d884af554447c418cefe3329b336
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.5.2
|
Security for shade 1.33.0
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.