Client library for OpenStack containing Infra business logic
Python Shell
stmcginnis Remove redundant target in README
An 'example' anchor was being explicitly added that was
redundant with the 'Example' title it preceeded. This
causes failures with `python check -s -r` which
was added to release validation to prevent pypi package
upload failures.

Since the README is imported into the built docs, and the
docs link to the examples using this hidden anchor, this
renames it to avoid a conflict.

Change-Id: I6947e0ae420402cc9866e3c374626392b1d5194c
Latest commit df4c581 Jul 20, 2018
Failed to load latest commit information.
devstack Add a devstack plugin for shade Oct 20, 2016
doc Remove redundant target in README Jul 20, 2018
extras List ansible/ansible in required-projects Jan 9, 2018
playbooks/devstack Fetch tox dir and html reports Feb 17, 2018
releasenotes remove redundant information from release notes build Apr 30, 2018
shade Use valid filters to list floating IPs in neutron Jul 19, 2018
.coveragerc Start using keystoneauth for keystone sessions Sep 21, 2015
.gitignore Switch to using stestr Sep 8, 2017
.gitreview Change meta info to be an Infra project Jan 7, 2015
.mailmap Add entry for James Blair to .mailmap Oct 23, 2015
.stestr.conf Switch to using stestr Sep 8, 2017
.zuul.yaml Merge "Remove shade-ansible-devel job" Jul 5, 2018
CONTRIBUTING.rst Add minor OperatorCloud documentation Apr 30, 2015
HACKING.rst Update HACKING.rst with a couple of shade specific notes Aug 21, 2016
LICENSE Initial cookiecutter repo Aug 31, 2014 Initial cookiecutter repo Aug 31, 2014
README.rst Remove redundant target in README Jul 20, 2018
bindep.txt Add libffi-dev to bindep.txt Sep 6, 2016
lower-constraints.txt Make OpenStackCloud a subclass of Connection Jul 13, 2018
requirements.txt Make OpenStackCloud a subclass of Connection Jul 13, 2018
setup.cfg Build universal wheels Apr 13, 2018 Updated from global requirements Mar 30, 2017
test-requirements.txt Updated from global requirements Mar 23, 2018
tox.ini fix tox python3 overrides Jun 6, 2018



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.


Sometimes an example is nice.

  1. Create a clouds.yml file:

       region_name: RegionOne
         username: 'mordred'
         password: XXXXXXX
         project_name: 'shade'
         auth_url: ''

    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

  2. Create a server with shade, configured with the clouds.yml file:

    import shade
    # Initialize and turn on debug logging
    # 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.
        'my-server', image=image, flavor=flavor, wait=True, auto_ip=True)