Skip to content

schubergphilis/oktalib

Repository files navigation

oktalib

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

Usage

Legacy: pip install oktalib

Preferred: uv add oktalib

Developing further

Development flow as Paleofuturistic Python

Prerequisite: uv

Setup

  • Fork and clone this repository.
  • Download additional dependencies: uv sync --all-extras --dev
  • Optional: validate the setup with
    • uv run pytest tests
    • uv run pylint src tests

Workflow

  • Download dependencies (if you need any): uv add some_lib_you_need
  • Develop (optional, tinker: uvx --with-editable . ptpython)
  • QA:
    • Format: uv run ruff format
    • Lint: uv run ruff check
    • Type check: uv run mypy
    • Test: uv run python -m unittest
  • Build (to validate it works): uv build
  • Review documentation updates: uv run mkdocs serve
  • Make a pull request.

Pipeline

Relevant for the maintainers of the repository.

  • Github action release (Release Please) is using a PAT which expires. More about this can be found at paleofuturistic docs.
  • Github action publish uses OIDC credentials for PyPI, check in PyPI if this stops working.

About

A python library for interfacing with OKTA's api

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages