keepup-users 0.4.0__tar.gz

keepup_users-0.4.0/PKG-INFO

@@ -0,0 +1,18 @@
+Metadata-Version: 2.4
+Name: keepup-users
+Version: 0.4.0
+Summary: Accounts, the roles they hold and the rights granted.
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: keepup-db>=0.4.0
+
+# keepup-users
+
+Accounts, the roles they hold and the rights granted.
+
+One capability of [keepup](https://github.com/FedorSergeev/keepup-admin), the framework over FastAPI for admin
+panels: the base is installed as `keepup-admin` and imported as `keepup`, and
+this distribution carries one part of it. It is installed on its own
+(`pip install keepup-users`) or together with the base (`pip install "keepup-admin[panel]"`),
+and it declares itself to the kernel through its
+`[project.entry-points."keepup.plugins"]` entry point.

keepup_users-0.4.0/README.md

@@ -0,0 +1,10 @@
+# keepup-users
+
+Accounts, the roles they hold and the rights granted.
+
+One capability of [keepup](https://github.com/FedorSergeev/keepup-admin), the framework over FastAPI for admin
+panels: the base is installed as `keepup-admin` and imported as `keepup`, and
+this distribution carries one part of it. It is installed on its own
+(`pip install keepup-users`) or together with the base (`pip install "keepup-admin[panel]"`),
+and it declares itself to the kernel through its
+`[project.entry-points."keepup.plugins"]` entry point.

keepup_users-0.4.0/keepup_users/__init__.py

@@ -0,0 +1,12 @@
+"""Accounts, the roles they hold and the rights granted.
+
+This distribution provides `users` and declares one plugin,
+`users`, in the `keepup.plugins` group. It depends on `keepup-admin`
+for the constructor -- the descriptor, the catalogue, the service registry and
+the lifecycle -- and on nothing of another capability.
+
+The code moves here in keepup-124: until then the plugin lives in the framework's
+own `builtin/users.py` and this package is the home it is moving to.
+"""
+
+__version__ = "0.4.0"

keepup_users-0.4.0/keepup_users/tables.py

@@ -0,0 +1,83 @@
+"""The tables of the accounts, declared where the capability lives.
+
+Task keepup-124. `keepup.schema` re-exports them for one release, so every
+importer keeps working while the accounts capability, its module and its plugin
+travel into this distribution; nothing that reads a user row imports the kernel
+for it.
+"""
+
+from sqlalchemy import Boolean, Column, DateTime, Index, Integer, Text, UniqueConstraint
+from sqlalchemy import text as sql_text
+
+from keepup_db import tables
+
+__all__ = ["EXTERNAL_ROLE_MAPPINGS", "USERS", "USER_PERMISSIONS", "USER_ROLES"]
+
+USERS = tables.table(
+    "users",
+    tables.auto_id(),
+    Column("username", Text, unique=True, nullable=False),
+    Column("password_hash", Text, nullable=False),
+    Column("status", Text, server_default="blocked"),
+    Column("role", Text, server_default="CLIENT"),
+    Column("created_at", DateTime, server_default=tables.NOW),
+    Column("external_id", Text),
+    Column("auth_source", Text, server_default="local"),
+    Column("last_external_sync", DateTime),
+    Column("email", Text),
+    Column("phone", Text),
+    Column("full_name", Text),
+    Column("updated_at", DateTime),
+    Column("agree_terms", Boolean),
+    # One external identity, one account. Partial: a local account has no
+    # external id at all, and several of those must coexist.
+    Index("users_external_identity_unique", "auth_source", "external_id", unique=True,
+          postgresql_where=sql_text("external_id IS NOT NULL"),
+          sqlite_where=sql_text("external_id IS NOT NULL")),
+)
+
+USER_ROLES = tables.table(
+    "user_roles",
+    tables.auto_id(),
+    Column("user_id", Integer, nullable=False),
+    Column("role_name", Text, nullable=False),
+    Column("granted_at", DateTime, server_default=tables.NOW),
+    tables.foreign_key("user_id", "users", ("id",), ondelete="CASCADE"),
+    UniqueConstraint("user_id", "role_name", name="user_roles_user_role_unique")
+    .ddl_if(dialect="postgresql"),
+    Index("idx_user_roles_user", "user_id"),
+    Index("user_roles_user_role_unique", "user_id", "role_name",
+          unique=True).ddl_if(dialect="sqlite"),
+)
+
+USER_PERMISSIONS = tables.table(
+    "user_permissions",
+    tables.auto_id(),
+    Column("user_id", Integer, nullable=False),
+    Column("permission_name", Text, nullable=False),
+    Column("granted", Boolean, server_default=sql_text("FALSE")),
+    Column("created_at", DateTime, server_default=tables.NOW),
+    Column("updated_at", DateTime, server_default=tables.NOW),
+    tables.foreign_key("user_id", "users", ("id",), ondelete="CASCADE"),
+    UniqueConstraint("user_id", "permission_name",
+                     name="user_permissions_user_permission_unique").ddl_if(dialect="postgresql"),
+    Index("idx_user_permissions_user_id", "user_id"),
+    Index("idx_user_permissions_permission", "permission_name"),
+    Index("user_permissions_user_permission_unique", "user_id", "permission_name",
+          unique=True).ddl_if(dialect="sqlite"),
+)
+
+EXTERNAL_ROLE_MAPPINGS = tables.table(
+    "external_role_mappings",
+    tables.auto_id(),
+    Column("external_role_name", Text, nullable=False),
+    Column("internal_permission_name", Text, nullable=False),
+    Column("auth_source", Text, nullable=False),
+    Column("created_at", DateTime, server_default=tables.NOW),
+    UniqueConstraint("external_role_name", "auth_source", "internal_permission_name",
+                     name="external_role_mappings_unique").ddl_if(dialect="postgresql"),
+    Index("idx_ext_role_mappings_source", "auth_source"),
+    Index("idx_ext_role_mappings_role", "external_role_name"),
+    Index("external_role_mappings_unique", "external_role_name", "auth_source",
+          "internal_permission_name", unique=True).ddl_if(dialect="sqlite"),
+)

keepup_users-0.4.0/keepup_users.egg-info/PKG-INFO

@@ -0,0 +1,18 @@
+Metadata-Version: 2.4
+Name: keepup-users
+Version: 0.4.0
+Summary: Accounts, the roles they hold and the rights granted.
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: keepup-db>=0.4.0
+
+# keepup-users
+
+Accounts, the roles they hold and the rights granted.
+
+One capability of [keepup](https://github.com/FedorSergeev/keepup-admin), the framework over FastAPI for admin
+panels: the base is installed as `keepup-admin` and imported as `keepup`, and
+this distribution carries one part of it. It is installed on its own
+(`pip install keepup-users`) or together with the base (`pip install "keepup-admin[panel]"`),
+and it declares itself to the kernel through its
+`[project.entry-points."keepup.plugins"]` entry point.

keepup_users-0.4.0/keepup_users.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+README.md
+pyproject.toml
+keepup_users/__init__.py
+keepup_users/tables.py
+keepup_users.egg-info/PKG-INFO
+keepup_users.egg-info/SOURCES.txt
+keepup_users.egg-info/dependency_links.txt
+keepup_users.egg-info/entry_points.txt
+keepup_users.egg-info/requires.txt
+keepup_users.egg-info/top_level.txt

keepup_users-0.4.0/keepup_users.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

keepup_users-0.4.0/keepup_users.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[keepup.plugins]
+users = keepup_users:UsersPlugin

keepup_users-0.4.0/keepup_users.egg-info/requires.txt

@@ -0,0 +1 @@
+keepup-db>=0.4.0

keepup_users-0.4.0/keepup_users.egg-info/top_level.txt

@@ -0,0 +1 @@
+keepup_users

keepup_users-0.4.0/pyproject.toml

@@ -0,0 +1,19 @@
+[build-system]
+requires = ["setuptools>=68"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "keepup-users"
+version = "0.4.0"
+description = "Accounts, the roles they hold and the rights granted."
+readme = "README.md"
+requires-python = ">=3.11"
+dependencies = [
+    "keepup-db>=0.4.0",
+]
+
+[project.entry-points."keepup.plugins"]
+users = "keepup_users:UsersPlugin"
+
+[tool.setuptools]
+packages = ["keepup_users"]

keepup_users-0.4.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+