Skip to main content

A library to interface with okta through it's restful api

Project description

A python library for interfacing with OKTA’s 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

  • Manages groups, users and applications

Todo

  • This code is MVP. It requires a lot of optimizations and extensions.

  • Things to do are, try to make the retrieving faster and implement smart caching for entities.

History

0.1.0 (25-05-2018)

  • First release

1.0.0 (19-10-2018)

  • Updated template to python3.7 Dropped support for python2.7

1.1.0 (23-10-2018)

  • Added setting of user password capability

1.1.1 (25-10-2018)

  • Updated template and dependencies

1.1.2 (17-12-2018)

  • Updated requests version.

1.1.3 (11-01-2019)

  • Updated requests module and fixed requirements generation.

1.1.4 (20-09-2019)

  • Update get_applicatio_by_id

1.1.5 (20-09-2019)

  • Added limit

1.1.6 (23-09-2019)

  • Fix applications method

1.1.7 (18-10-2019)

  • bumped dependencies

1.1.8 (18-10-2019)

  • Updated template and bumped dependencies

1.1.9 (19-12-2019)

  • Added feature for aws application

1.1.10 (13-01-2020)

  • Added api exhaustion backoff.

1.1.11 (13-01-2020)

  • Corrected Pipfile.lock issue.

1.1.12 (09-06-2020)

  • Bumped requests

1.1.13 (17-06-2020)

  • fixed applications entity

1.2.0 (09-10-2020)

  • bumped requests

1.3.0 (02-12-2020)

  • Bumped requests

1.4.0 (15-03-2021)

  • Added property setters for user attributes.

1.4.1 (26-04-2021)

  • Bumped dependencies.

1.4.2 (08-06-2021)

  • Bumped dependencies.

1.4.3 (08-06-2021)

  • Updated reference of pypi to simple from legacy.

1.4.4 (08-06-2021)

  • Updated pypi reference.

1.4.5 (08-06-2021)

  • Reverted pypi reference to legacy.

1.5.0 (24-03-2022)

  • Added User and Group assignment roles.

1.6.0 (28-03-2022)

  • Made entities comparable.

1.6.1 (22-04-2022)

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

oktalib-1.6.1.tar.gz (87.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

oktalib-1.6.1-py3.7.egg (104.0 kB view details)

Uploaded Egg

File details

Details for the file oktalib-1.6.1.tar.gz.

File metadata

  • Download URL: oktalib-1.6.1.tar.gz
  • Upload date:
  • Size: 87.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.8.2 requests/2.27.1 setuptools/62.1.0 requests-toolbelt/0.9.1 tqdm/4.64.0 CPython/3.7.10

File hashes

Hashes for oktalib-1.6.1.tar.gz
Algorithm Hash digest
SHA256 228f015b0cfcce482c46ca7082aee38dd31c983c1f169be1f5f66e3b6ea931c3
MD5 7e3d58a55d887546eed2b2872535a39e
BLAKE2b-256 d43836e9b29257dea6befc6b75c94426bef114db99e6db59809b8d2f3ee98804

See more details on using hashes here.

File details

Details for the file oktalib-1.6.1-py3.7.egg.

File metadata

  • Download URL: oktalib-1.6.1-py3.7.egg
  • Upload date:
  • Size: 104.0 kB
  • Tags: Egg
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.8.2 requests/2.27.1 setuptools/62.1.0 requests-toolbelt/0.9.1 tqdm/4.64.0 CPython/3.7.10

File hashes

Hashes for oktalib-1.6.1-py3.7.egg
Algorithm Hash digest
SHA256 ba5340e68e837ba0c24d665536ec2a901fbb13362646eac503b9e4f9fcb22485
MD5 37169110da3a0e488d495354f1bb1415
BLAKE2b-256 a528c3a4f1f1676d279fcdbc3221222ffcf7f11ccbfa5f97462dada7c15177a6

See more details on using hashes here.

Supported by

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