| Name | maykin-auth-matrix JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | None |
| Summary | TODO |
| upload_time | 2024-07-11 09:19:15 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | Copyright 2024 Maykin Media Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
todo
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
Welcome to maykin-auth-matrix's documentation!
=================================================
:Version: 0.1.0
:Source: https://github.com/maykinmedia/maykin-auth-matrix
:Keywords: ``<keywords>``
:PythonVersion: 3.10
|build-status| |code-quality| |black| |coverage| |docs|
|python-versions| |django-versions| |pypi-version|
DigiD Compliant Authorization Matrix for the administation of Django projects.
.. contents::
.. section-numbering::
Features
========
* Display a matrix of permissions for the groups
* Display a matrix of groups for the users
* Allows to export the matrix in different formats
Installation
============
Requirements
------------
* Python 3.10 or above
* Django 4.2 or newer
Install
-------
.. code-block:: bash
pip install maykin-auth-matrix
Usage
=====
Add the URL to your Django project's ``urls.py``:
.. code-block:: python
from django.contrib import admin
from django.urls import path, include
from auth_matrix.views import AuthMatrixView
urlpatterns = [
path(
"admin/authorization/",
include("auth_matrix.admin_urls"),
),
]
# Display the Authorization Matrix
.. image:: images/authorization_matrix.png
:alt: Authorization Matrix
Navigate to the Groups admin page and click on the "Authorization Matrix" link to view the matrix.
.. image:: images/authorization_button.png
:alt: Show Authorization Matrix Button
# Export the Authorization Matrix
On the top right corner of the Groups admin page, you can choose to export the matrix to different formats.
Click the EXPORT button and chose the format you want to export the matrix to.
.. image:: images/export_matrix.png
:alt: Export Authorization Matrix Button
You can pick between two resources:
- UserGroupResource : exports the matrix with users as rows and groups as columns
- GroupPermissionsResource : exports the matrix with permissions as rows and groups as columns
.. image:: images/export_matrix_format.png
:alt: Export Authorization Matrix Formats
Local development
=================
To install and develop the library locally, use::
.. code-block:: bash
pip install -e .[tests,coverage,docs,release]
When running management commands via ``django-admin``, make sure to add the root
directory to the python path (or use ``python -m django <command>``):
.. code-block:: bash
export PYTHONPATH=. DJANGO_SETTINGS_MODULE=testapp.settings
django-admin check
# or other commands like:
# django-admin makemessages -l nl
.. |build-status| image:: https://github.com/maykinmedia/maykin-auth-matrix/workflows/Run%20CI/badge.svg
:alt: Build status
:target: https://github.com/maykinmedia/maykin-auth-matrix/actions?query=workflow%3A%22Run+CI%22
.. |code-quality| image:: https://github.com/maykinmedia/maykin-auth-matrix/workflows/Code%20quality%20checks/badge.svg
:alt: Code quality checks
:target: https://github.com/maykinmedia/maykin-auth-matrix/actions?query=workflow%3A%22Code+quality+checks%22
.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
.. |coverage| image:: https://codecov.io/gh/maykinmedia/maykin-auth-matrix/branch/main/graph/badge.svg
:target: https://codecov.io/gh/maykinmedia/maykin-auth-matrix
:alt: Coverage status
.. |docs| image:: https://readthedocs.org/projects/maykin-auth-matrix/badge/?version=latest
:target: https://maykin-auth-matrix.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. |python-versions| image:: https://img.shields.io/pypi/pyversions/maykin-auth-matrix.svg
.. |django-versions| image:: https://img.shields.io/pypi/djversions/maykin-auth-matrix.svg
.. |pypi-version| image:: https://img.shields.io/pypi/v/maykin-auth-matrix.svg
:target: https://pypi.org/project/maykin-auth-matrix/
Raw data
{
"_id": null,
"home_page": null,
"name": "maykin-auth-matrix",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "TODO",
"author": null,
"author_email": "Maykin Media <support@maykinmedia.nl>",
"download_url": "https://files.pythonhosted.org/packages/5e/3a/1a4f46af9d89760f0f5c3384ab046f203d0883122176325c676cf3b4388a/maykin_auth_matrix-0.1.1.tar.gz",
"platform": null,
"description": "\n\nWelcome to maykin-auth-matrix's documentation!\n=================================================\n\n:Version: 0.1.0\n:Source: https://github.com/maykinmedia/maykin-auth-matrix\n:Keywords: ``<keywords>``\n:PythonVersion: 3.10\n\n|build-status| |code-quality| |black| |coverage| |docs|\n\n|python-versions| |django-versions| |pypi-version|\n\nDigiD Compliant Authorization Matrix for the administation of Django projects.\n\n.. contents::\n\n.. section-numbering::\n\nFeatures\n========\n\n* Display a matrix of permissions for the groups\n* Display a matrix of groups for the users\n* Allows to export the matrix in different formats\n\nInstallation\n============\n\nRequirements\n------------\n\n* Python 3.10 or above\n* Django 4.2 or newer\n\n\nInstall\n-------\n\n.. code-block:: bash\n\n pip install maykin-auth-matrix\n\n\nUsage\n=====\n\nAdd the URL to your Django project's ``urls.py``:\n\n.. code-block:: python\n\n from django.contrib import admin\n from django.urls import path, include\n from auth_matrix.views import AuthMatrixView\n\n urlpatterns = [\n path(\n \"admin/authorization/\",\n include(\"auth_matrix.admin_urls\"),\n ),\n ]\n\n# Display the Authorization Matrix\n\n.. image:: images/authorization_matrix.png\n :alt: Authorization Matrix\n\nNavigate to the Groups admin page and click on the \"Authorization Matrix\" link to view the matrix.\n\n.. image:: images/authorization_button.png\n :alt: Show Authorization Matrix Button\n\n# Export the Authorization Matrix\n\nOn the top right corner of the Groups admin page, you can choose to export the matrix to different formats.\n\nClick the EXPORT button and chose the format you want to export the matrix to.\n\n.. image:: images/export_matrix.png\n :alt: Export Authorization Matrix Button \n\nYou can pick between two resources:\n - UserGroupResource : exports the matrix with users as rows and groups as columns\n - GroupPermissionsResource : exports the matrix with permissions as rows and groups as columns\n\n.. image:: images/export_matrix_format.png\n :alt: Export Authorization Matrix Formats\n\nLocal development\n=================\n\nTo install and develop the library locally, use::\n\n.. code-block:: bash\n\n pip install -e .[tests,coverage,docs,release]\n\nWhen running management commands via ``django-admin``, make sure to add the root\ndirectory to the python path (or use ``python -m django <command>``):\n\n.. code-block:: bash\n\n export PYTHONPATH=. DJANGO_SETTINGS_MODULE=testapp.settings\n django-admin check\n # or other commands like:\n # django-admin makemessages -l nl\n\n\n.. |build-status| image:: https://github.com/maykinmedia/maykin-auth-matrix/workflows/Run%20CI/badge.svg\n :alt: Build status\n :target: https://github.com/maykinmedia/maykin-auth-matrix/actions?query=workflow%3A%22Run+CI%22\n\n.. |code-quality| image:: https://github.com/maykinmedia/maykin-auth-matrix/workflows/Code%20quality%20checks/badge.svg\n :alt: Code quality checks\n :target: https://github.com/maykinmedia/maykin-auth-matrix/actions?query=workflow%3A%22Code+quality+checks%22\n\n.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n\n.. |coverage| image:: https://codecov.io/gh/maykinmedia/maykin-auth-matrix/branch/main/graph/badge.svg\n :target: https://codecov.io/gh/maykinmedia/maykin-auth-matrix\n :alt: Coverage status\n\n.. |docs| image:: https://readthedocs.org/projects/maykin-auth-matrix/badge/?version=latest\n :target: https://maykin-auth-matrix.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\n.. |python-versions| image:: https://img.shields.io/pypi/pyversions/maykin-auth-matrix.svg\n\n.. |django-versions| image:: https://img.shields.io/pypi/djversions/maykin-auth-matrix.svg\n\n.. |pypi-version| image:: https://img.shields.io/pypi/v/maykin-auth-matrix.svg\n :target: https://pypi.org/project/maykin-auth-matrix/\n",
"bugtrack_url": null,
"license": "Copyright 2024 Maykin Media Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "TODO",
"version": "0.1.1",
"project_urls": {
"Bug Tracker": "https://github.com/maykinmedia/maykin-auth-matrix/issues",
"Documentation": "http://maykin-auth-matrix.readthedocs.io/en/latest/",
"Homepage": "https://github.com/maykinmedia/maykin-auth-matrix",
"Source Code": "https://github.com/maykinmedia/maykin-auth-matrix"
},
"split_keywords": [
"todo"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ca6863bde3e9eaa80f6312b5561dd5b7dd97b7a64de5182611d94c414f049ce7",
"md5": "abe5cf8228784ea822d18f585b66e60b",
"sha256": "ddf4046b0d7c35b70237df4631ad0e9e8ff240d71b6cf0a1fdf93ef3d7a028e4"
},
"downloads": -1,
"filename": "maykin_auth_matrix-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "abe5cf8228784ea822d18f585b66e60b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 9257,
"upload_time": "2024-07-11T09:19:14",
"upload_time_iso_8601": "2024-07-11T09:19:14.144649Z",
"url": "https://files.pythonhosted.org/packages/ca/68/63bde3e9eaa80f6312b5561dd5b7dd97b7a64de5182611d94c414f049ce7/maykin_auth_matrix-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5e3a1a4f46af9d89760f0f5c3384ab046f203d0883122176325c676cf3b4388a",
"md5": "ecbe3ef406187a635b559327ed709baf",
"sha256": "397d16eace556bf12fc16d86f3499a4df8e36b6680557eebb5fb1acb4e816b70"
},
"downloads": -1,
"filename": "maykin_auth_matrix-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "ecbe3ef406187a635b559327ed709baf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 9975,
"upload_time": "2024-07-11T09:19:15",
"upload_time_iso_8601": "2024-07-11T09:19:15.909087Z",
"url": "https://files.pythonhosted.org/packages/5e/3a/1a4f46af9d89760f0f5c3384ab046f203d0883122176325c676cf3b4388a/maykin_auth_matrix-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-11 09:19:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "maykinmedia",
"github_project": "maykin-auth-matrix",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "maykin-auth-matrix"
}
