[FC-0099] feat: add public API to interact with roles and permissions (#75)

Introduce the public Python APIs for Open edX AuthZ. These modules expose role, permission, and user-assignment operations as an abstraction on top of the Casbin engine. The design follows a bottom-up approach: a type-safe data layer, low-level APIs for roles and permissions, and a user-facing convenience API (user-assignment).

Author: mariajgrimaldi

.gitignore

@@ -64,5 +64,6 @@ docs/openedx_authz.*.rst
 requirements/private.in
 requirements/private.txt
 
-# Sqlite Database
+# Persistent database files
+*.sqlite3
 *.db

CHANGELOG.rst

@@ -22,4 +22,14 @@ Unreleased
 Added
 =====
 
-* First release on PyPI.
+* Basic repo structure and initial setup.
+
+0.2.0 - 2025-10-10
+******************
+
+Added
+=====
+
+* ADRs for key design decisions.
+* Casbin model (CONF) and engine layer for authorization.
+* Implementation of public API for roles and permissions management.

docs/conf.py

@@ -47,7 +47,11 @@ def get_version(*file_paths):
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-#
+
+autodoc_mock_imports = [
+    "openedx_authz.api",
+]
+
 # import os
 # import sys
 # sys.path.insert(0, os.path.abspath('.'))
@@ -72,6 +76,7 @@ def get_version(*file_paths):
 # A list of warning types to suppress arbitrary warning messages.
 suppress_warnings = [
     "image.nonlocal_uri",
+    "autodoc.mocked_object"
 ]
 
 # Add any paths that contain templates here, relative to this directory.

openedx_authz/api/__init__.py

@@ -0,0 +1,11 @@
+"""Public API for the Open edX AuthZ framework.
+
+This module provides a public API as part of the Open edX AuthZ framework. This
+is part of the Open edX Layer used to abstract the authorization engine and
+provide a simpler interface for other services in the Open edX ecosystem.
+"""
+
+from openedx_authz.api.data import *
+from openedx_authz.api.permissions import *
+from openedx_authz.api.roles import *
+from openedx_authz.api.users import *