Browse and manage AWS identity and organization resources.
Project description
aws_org_client
Contents
Overview
This project is a python package, aimed at providing a simple interface with AWS organisation & identity services.
Using boto3 clients:
- identitystore
- organizations
- sso-admin
Example Usage
Setup boto session & initialise organisations client to list accounts.
import boto3
from aws_org_client.organizations import Organizations
session = boto3.Session(profile_name='my_profile', region_name='my_region')
client = Organizations()
client.list_accounts()
Example response:
[
{
"Id": "string",
"Arn": "string",
"Email": "string",
"Name": "string",
"Status": "ACTIVE",
"JoinedMethod": "CREATED",
"JoinedTimestamp": datetime.datetime(1970, 1, 1, 00, 00, 00, 000000, tzinfo=tzlocal())
}
]
Development
Requirements
- Install python poetry.
- You will need a working aws profile configured in your filesystem.
Setup
Initialise a poetry environment:
poetry shell
Install dependencies:
poetry install
Project processes
Coverage report
run coverage report:
poetry run coverage run -m --source=aws_org_client pytest tests
poetry run coverage report
Linting
run pylint with:
poetry run pylint aws_org_client
poetry run pylint tests
Formatting
run black formatter with:
poetry run black .
SAST
run bandit scanner:
poetry run bandit .
Documentation
this project uses sphinx to produce a static html site; published to github pages.
github actions takes care of building the site & publishing it.
to update the files used to build documentation use:
poetry run sphinx-apidoc --ext-autodoc -f -o docs .
include any changes to the docs directory
Build Documentation locally
you may wish to build documentation locally before publishing it.
form the project root run:
poetry run sphinx-build docs _build
this will create directory _build
in the project root where you can load
html in your browser.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for aws_org_client-0.0.9-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 478b84e1c2d620a71f393b22af39274f759d005b22609c3877c2e910bf7b38f4 |
|
MD5 | ea4d9dcb10cea3717e19df6f5f72977c |
|
BLAKE2b-256 | 5892a25226ce10141fd5a1e1462ef3ce69f7ac0d3244f98ca8533cedbb5e6ed2 |