user-permission 0.1.0__tar.gz

user_permission-0.1.0/LICENSE-APACHE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 mokuichi147
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

user_permission-0.1.0/LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 mokuichi147
+
+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.

user_permission-0.1.0/PKG-INFO

@@ -0,0 +1,284 @@
+Metadata-Version: 2.4
+Name: user-permission
+Version: 0.1.0
+Summary: Add your description here
+Author: mokuichi147
+Author-email: mokuichi147 <38586357+Mokuichi147@users.noreply.github.com>
+License-Expression: MIT OR Apache-2.0
+License-File: LICENSE-APACHE
+License-File: LICENSE-MIT
+Requires-Dist: aiosqlite>=0.22.1
+Requires-Dist: pwdlib[argon2]>=0.3.0
+Requires-Dist: pyjwt>=2.12.1
+Requires-Dist: fastapi>=0.115.0 ; extra == 'fastapi'
+Requires-Dist: python-multipart>=0.0.18 ; extra == 'fastapi'
+Requires-Dist: httpx>=0.28.0 ; extra == 'relay'
+Requires-Dist: fastapi>=0.115.0 ; extra == 'server'
+Requires-Dist: python-multipart>=0.0.18 ; extra == 'server'
+Requires-Dist: uvicorn>=0.34.0 ; extra == 'server'
+Requires-Python: >=3.12.10
+Provides-Extra: fastapi
+Provides-Extra: relay
+Provides-Extra: server
+Description-Content-Type: text/markdown
+
+# UserPermission
+
+ユーザーとグループを管理するための非同期Pythonライブラリです。
+
+- **aiosqlite** による非同期SQLiteデータベース管理
+- **pwdlib (Argon2)** によるパスワードハッシュ化
+- **PyJWT** によるJWTトークンの発行・検証
+
+## インストール
+
+```bash
+uv sync
+
+# FastAPI連携を使う場合
+uv sync --extra fastapi
+
+# サーバーとして起動する場合（uvicorn含む）
+uv sync --extra server
+
+# リレークライアントを使う場合（httpx含む）
+uv sync --extra relay
+```
+
+## 使い方
+
+### 初期化
+
+```python
+import asyncio
+from user_permission import Database
+
+async def main():
+    # 初回実行時にシークレットキーを自動生成（以降はファイルから読み込み）
+    async with Database("app.db", secret_key="secret.key") as db:
+        # db.users / db.groups ですぐに使える
+        user = await db.users.create("alice", "password123")
+        group = await db.groups.create("admins")
+
+asyncio.run(main())
+```
+
+### ユーザー管理
+
+```python
+# 作成
+user = await db.users.create("alice", "password123", display_name="Alice")
+
+# 取得
+user = await db.users.get_by_id(1)
+user = await db.users.get_by_username("alice")
+
+# 一覧
+users = await db.users.list_all()
+
+# 更新（パスワード変更など）
+await db.users.update(user.id, password="new_password")
+await db.users.update(user.id, display_name="Alice Smith")
+
+# 無効化
+await db.users.update(user.id, is_active=False)
+
+# 削除
+await db.users.delete(user.id)
+```
+
+### 認証・トークン
+
+```python
+# ログイン認証（成功時にJWTトークンを返す、失敗時はNone）
+token = await db.users.authenticate("alice", "password123")
+
+# トークンの有効期限を指定
+from datetime import timedelta
+token = await db.users.authenticate("alice", "password123", expires_delta=timedelta(hours=24))
+
+# トークン検証
+payload = db.token_manager.verify_token(token)
+print(payload["sub"])       # ユーザーID（文字列）
+print(payload["username"])  # ユーザー名
+```
+
+### グループ管理
+
+```python
+# 作成
+group = await db.groups.create("admins", description="Administrator group")
+
+# 取得
+group = await db.groups.get_by_id(1)
+group = await db.groups.get_by_name("admins")
+
+# 一覧
+groups = await db.groups.list_all()
+
+# 更新
+await db.groups.update(group.id, description="Updated description")
+
+# 削除
+await db.groups.delete(group.id)
+```
+
+### グループメンバー管理
+
+```python
+# ユーザーをグループに追加
+await db.groups.add_user(group.id, user.id)
+
+# ユーザーをグループから削除
+await db.groups.remove_user(group.id, user.id)
+
+# グループのメンバー一覧
+members = await db.groups.get_members(group.id)
+
+# ユーザーの所属グループ一覧
+groups = await db.groups.get_user_groups(user.id)
+```
+
+### サーバー起動
+
+`user-permission[server]` でインストールすると、CLIからサーバーを起動できます。
+
+```bash
+uv run user-permission serve --host localhost --port 8001
+```
+
+| オプション | デフォルト | 説明 |
+|---|---|---|
+| `--host` | `127.0.0.1` | バインドアドレス |
+| `--port` | `8000` | バインドポート |
+| `--database` | `user_permission.db` | SQLiteデータベースのパス |
+| `--secret` | `secret.key` | シークレットキーファイルのパス |
+| `--prefix` | (なし) | APIルートプレフィックス（例: `/api`） |
+
+### リレー（中継）
+
+`user-permission[relay]` でインストールすると、他のアプリから中央のUserPermissionサーバーへ中継できます。
+`connect()` に渡すパスを変えるだけで、ローカルDBとリレーを切り替えられます。
+
+```python
+from user_permission import connect
+
+# ファイルパス → ローカルDB
+backend = connect("app.db", secret="secret.key")
+
+# URL → リレー（リモートサーバーへ中継）
+backend = connect("http://localhost:8001")
+```
+
+#### RelayClient（プログラム的な中継）
+
+```python
+from user_permission.relay import RelayClient
+
+async with RelayClient("http://localhost:8001") as relay:
+    # ログイン
+    token = await relay.login("alice", "password123")
+
+    # トークン検証
+    user = await relay.verify_token(token)
+
+    # ユーザー・グループ操作（認証トークン付き）
+    users = await relay.users.list_all(token)
+    group = await relay.groups.create("admins", "Admin group", token)
+    await relay.groups.add_user(group.id, user.id, token)
+```
+
+#### リレールーター（FastAPIアプリに中継ルーターをマウント）
+
+別のFastAPIアプリにマウントすると、全リクエストが中央サーバーへ透過的に中継されます。
+
+```python
+from contextlib import asynccontextmanager
+from fastapi import FastAPI
+from user_permission.relay import RelayClient, create_relay_router
+
+relay = RelayClient("http://localhost:8001")
+
+@asynccontextmanager
+async def lifespan(app: FastAPI):
+    await relay.connect()
+    yield
+    await relay.close()
+
+app = FastAPI(lifespan=lifespan)
+app.include_router(create_relay_router(relay, prefix="/auth"))
+# /auth/token, /auth/me, /auth/users, ... が全て中央サーバーへ中継される
+```
+
+### FastAPI連携
+
+`user-permission[fastapi]` でインストールすると、ルーターを追加するだけでREST APIが使えます。
+
+```python
+from contextlib import asynccontextmanager
+from fastapi import FastAPI
+from user_permission import Database, create_router
+
+db = Database("app.db", secret_key="secret.key")
+
+@asynccontextmanager
+async def lifespan(app: FastAPI):
+    await db.connect()
+    yield
+    await db.close()
+
+app = FastAPI(lifespan=lifespan)
+app.include_router(create_router(db, prefix="/api"))
+```
+
+#### エンドポイント一覧
+
+| メソッド | パス | 説明 | 認証 |
+|---|---|---|---|
+| POST | `/api/token` | ログイン（トークン取得） | 不要 |
+| GET | `/api/me` | 現在のユーザー情報 | 必要 |
+| POST | `/api/users` | ユーザー作成 | 不要 |
+| GET | `/api/users` | ユーザー一覧 | 必要 |
+| GET | `/api/users/{id}` | ユーザー取得 | 必要 |
+| PATCH | `/api/users/{id}` | ユーザー更新（本人のみ） | 必要 |
+| DELETE | `/api/users/{id}` | ユーザー削除（本人のみ） | 必要 |
+| POST | `/api/groups` | グループ作成 | 必要 |
+| GET | `/api/groups` | グループ一覧 | 必要 |
+| GET | `/api/groups/{id}` | グループ取得 | 必要 |
+| PATCH | `/api/groups/{id}` | グループ更新 | 必要 |
+| DELETE | `/api/groups/{id}` | グループ削除 | 必要 |
+| POST | `/api/groups/{id}/members` | メンバー追加 | 必要 |
+| DELETE | `/api/groups/{id}/members/{user_id}` | メンバー削除 | 必要 |
+| GET | `/api/groups/{id}/members` | メンバー一覧 | 必要 |
+| GET | `/api/users/{id}/groups` | 所属グループ一覧 | 必要 |
+
+## データベーススキーマ
+
+| テーブル | 説明 |
+|---|---|
+| `users` | ユーザー情報（`username` は UNIQUE） |
+| `groups` | グループ情報（`name` は UNIQUE） |
+| `user_groups` | ユーザーとグループの多対多リレーション（複合PRIMARY KEY） |
+
+ユーザーまたはグループを削除すると、関連する `user_groups` レコードも自動的に削除されます（CASCADE）。
+
+## 依存パッケージ
+
+- [aiosqlite](https://pypi.org/project/aiosqlite/) - 非同期SQLite
+- [pwdlib[argon2]](https://pypi.org/project/pwdlib/) - パスワードハッシュ化
+- [PyJWT](https://pypi.org/project/PyJWT/) - JWTトークン
+
+オプション（`user-permission[fastapi]`）:
+- [FastAPI](https://pypi.org/project/fastapi/) - Web APIフレームワーク
+- [python-multipart](https://pypi.org/project/python-multipart/) - フォームデータ解析
+
+オプション（`user-permission[server]`）:
+- 上記FastAPI依存に加えて:
+- [uvicorn](https://pypi.org/project/uvicorn/) - ASGIサーバー
+
+オプション（`user-permission[relay]`）:
+- [httpx](https://pypi.org/project/httpx/) - 非同期HTTPクライアント
+
+## ライセンス
+
+MIT OR Apache-2.0