Skip to main content

A python library to interface with ansible tower's (awx) api.

Project description

A python library to interface with ansible tower’s (awx) api.

Development Workflow

The workflow supports the following steps

  • lint

  • test

  • build

  • document

  • upload

  • graph

These actions are supported out of the box by the corresponding scripts under _CI/scripts directory with sane defaults based on best practices. Sourcing setup_aliases.ps1 for windows powershell or setup_aliases.sh in bash on Mac or Linux will provide with handy aliases for the shell of all those commands prepended with an underscore.

The bootstrap script creates a .venv directory inside the project directory hosting the virtual environment. It uses pipenv for that. It is called by all other scripts before they do anything. So one could simple start by calling _lint and that would set up everything before it tried to actually lint the project

Once the code is ready to be delivered the _tag script should be called accepting one of three arguments, patch, minor, major following the semantic versioning scheme. So for the initial delivery one would call

$ _tag –minor

which would bump the version of the project to 0.1.0 tag it in git and do a push and also ask for the change and automagically update HISTORY.rst with the version and the change provided.

So the full workflow after git is initialized is:

  • repeat as necessary (of course it could be test - code - lint :) ) * code * lint * test

  • commit and push

  • develop more through the code-lint-test cycle

  • tag (with the appropriate argument)

  • build

  • upload (if you want to host your package in pypi)

  • document (of course this could be run at any point)

Important Information

This template is based on pipenv. In order to be compatible with requirements.txt so the actual created package can be used by any part of the existing python ecosystem some hacks were needed. So when building a package out of this do not simple call

$ python setup.py sdist bdist_egg

as this will produce an unusable artifact with files missing. Instead use the provided build and upload scripts that create all the necessary files in the artifact.

Project Features

  • Can get, create and delete all entities in a tower deployment.

Todo

This code is MVP and needs a lot of improvements. Some of them are, optimize all queries, implement searching and filtering and implement smart caching of entities.

History

0.1.0 (25-05-2018)

  • First release

0.2.0 (27-07-2018)

  • Refactored code to use entity managers for all tower objects saving a huge amount of network calls and implemented filtering

  • Removed pipenv locking mechanism as this is broken for python 2.7 completely

0.3.0 (01-08-2018)

  • Added capability to launch job template job

1.0.0 (27-09-2018)

  • Added support for specifying http or https and certificate verifications options

  • Extented the editing capabilities of hosts to name, description and enabled status

2.0.0 (16-10-2018)

  • Implemented dynamic attributes in running jobs.

  • Implemented cancel capabilities for running jobs.

  • Updated the template to python 3.7

  • Officially dropped support for python 2.7

2.0.1 (25-10-2018)

  • Update template and dependencies

2.0.2 (25-10-2018)

  • Reverted breaking change for upload script

2.0.3 (29-11-2018)

  • Fixed reference in the package for the right github repo

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

towerlib-2.0.3.tar.gz (180.0 kB view details)

Uploaded Source

Built Distribution

towerlib-2.0.3-py3.7.egg (236.1 kB view details)

Uploaded Egg

File details

Details for the file towerlib-2.0.3.tar.gz.

File metadata

  • Download URL: towerlib-2.0.3.tar.gz
  • Upload date:
  • Size: 180.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.0

File hashes

Hashes for towerlib-2.0.3.tar.gz
Algorithm Hash digest
SHA256 7606514d41da653d53f95c790dd17603d41390a885b908bf4445437baa149c88
MD5 9cf620d75840808abadd68ad6909b0c3
BLAKE2b-256 6879187f5399ae93a4be7169fbe90dfaef023c3ea99167a03e97cc2a69473ab5

See more details on using hashes here.

File details

Details for the file towerlib-2.0.3-py3.7.egg.

File metadata

  • Download URL: towerlib-2.0.3-py3.7.egg
  • Upload date:
  • Size: 236.1 kB
  • Tags: Egg
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.0

File hashes

Hashes for towerlib-2.0.3-py3.7.egg
Algorithm Hash digest
SHA256 294a1d399530129f990667458dc152ebc302bd09be47ab565de69ab4193470dc
MD5 fb123ed33f38a0d5b13f9024aa196b9b
BLAKE2b-256 23808f99d083710128124ed92c5be9e4e4e9ccf8432aa4c9f7076fa82a54a0ae

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page