Magpie Documentation

Magpie: A RestFul AuthN/AuthZ service

Magpie (the smart-bird)
a very smart bird who knows everything about you.

Magpie is service for AuthN/AuthZ accessible via a RestAPI implemented with the Pyramid web framework. It allows you to manage User/Group/Resource/Permission with a postgres database. Behind the scene, it uses Ziggurat-Foundations and Authomatic.

dependencies
Requires Python 2.7, 3.5+ Requirements Status
build status
Travis-CI Build Status (master branch) Travis-CI Build Status (latest tag) Readthedocs Build Status (master branch) Travis-CI CodeCov Coverage Codacy Badge
docker status
Docker Build Status (latest tag) Docker Build Status (latest tag)
releases
Latest Tag Commits since latest release

Documentation

The REST API documentation is auto-generated and served under {MAGPIE_URL}/api/ using Swagger-UI with tag latest.

More ample details about installation, configuration and usage are provided on readthedocs. These are generated from corresponding information provided in docs.

Configuration

Multiple configuration options exist for Magpie application.
Please refer to configuration for details.

Usage

See usage for details.

Change History

Addressed features, changes and bug fixes per version tag are available in HISTORY.

Docker Images

Following most recent variants are available:

Magpie Twitcher
(with integrated MagpieAdapter)
pavics/magpie:1.7.4 pavics/twitcher:magpie-1.7.4
pavics/magpie:latest pavics/twitcher:magpie-latest

Notes:

  • Older tags the are also available: Magpie Docker Images
  • Twitcher image with integrated MagpieAdapter are only available for Magpie >=1.0.0

Source Code

Indices and Tables