supernote 0.6.2__tar.gz → 0.8.0__tar.gz

{supernote-0.6.2 → supernote-0.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: supernote
-Version: 0.6.2
+Version: 0.8.0
 Summary: All-in-one toolkit for Supernote devices: parse notebooks, self-host services, access services
 Author-email: jya <jya@wizmy.net>, Allen Porter <allen.porter@gmail.com>
 License-Expression: Apache-2.0
@@ -24,6 +24,11 @@ Requires-Dist: aiohttp>=3.13.2; extra == "server"
 Requires-Dist: mashumaro>=3.17; extra == "server"
 Requires-Dist: pyyaml>=6.0; extra == "server"
 Requires-Dist: PyJWT>=2.10.1; extra == "server"
+Requires-Dist: SQLAlchemy[asyncio]>=2.0.0; extra == "server"
+Requires-Dist: alembic>=1.13.0; extra == "server"
+Requires-Dist: aiosqlite>=0.19.0; extra == "server"
+Requires-Dist: aiofiles>=25.1.0; extra == "server"
+Requires-Dist: aiohttp-remotes>=1.3.0; extra == "server"
 Provides-Extra: all
 Requires-Dist: supernote[client,server]; extra == "all"
 Dynamic: license-file
@@ -38,7 +43,7 @@ This content is shared between the [documentation](https://allenporter.github.io
 
 - **Notebook Parsing**: Convert `.note` files to PDF, PNG, SVG, or text
 - **Private Server**: Self-hosted Supernote Private Cloud implementation
-- **Client**: Interact with Supernote service API
+- **Client**: Interact with Supernote (Private) Cloud API
 
 ## Installation
 
@@ -53,16 +58,9 @@ pip install supernote[client]      # + Client
 pip install supernote[all]
 ```
 
-## Local Development
+## Local Development Setup
 
-Install in a virtual environment:
-
-```bash
-uv venv --python=3.14
-source .venv/bin/activate
-uv pip install -r requirements_dev.txt
-uv pip install -e ".[all]"
-```
+To set up the project for development, please refer to the [Contributing Guide](docs/CONTRIBUTING.md).
 
 ## Quick Start
 
@@ -79,38 +77,37 @@ The notebook parser is a fork and slightly lighter dependency version of [supern
 limitation. All credit goes to the original authors of [supernote-tool](https://github.com/jya-dev/supernote-tool) for providing an amazing low level utility.
 
 
-### Run Private Server
+### Server Setup & Bootstrap
 
-```bash
-# Generate configuration
-supernote-server config init > config.yaml
+1. **Start the Server**:
+   ```bash
+   supernote serve
+   ```
 
-# Generate users (outputs YAML, append to users.yaml)
-supernote-server user add alice >> users.yaml
+2. **Register the Admin**:
+   The first user registered becomes the system administrator.
+   ```bash
+   supernote admin user add email@example.com --url http://localhost:8080
+   ```
 
-# Start server
-supernote-server serve
-```
+3. **Login to CLI**:
+   ```bash
+   supernote cloud-login email@example.com --url http://localhost:8080
+   ```
+
+See the [Bootstrap Guide](docs/bootstrap_guide.md) for detailed deployment and security instructions.
 
 ### Run with Docker
 
 ```bash
 # Build image
-docker build -t supernote-server .
-
-# Generate initial configuration
-mkdir config
-docker run --rm supernote-server supernote-server config init > config/config.yaml
-docker run --rm -it supernote-server supernote-server user add alice >> config/users.yaml
+docker build -t supernote .
 
 # Run server
-docker run -d -p 8080:8080 \
-  -v $(pwd)/config:/config \
-  -v $(pwd)/storage:/data \
-  supernote-server
+docker run -d -p 8080:8080 -v $(pwd)/storage:/storage supernote serve
 ```
 
-See [Server Documentation](supernote/server/README.md) for details.
+See [Server Documentation](https://github.com/allenporter/supernote-lite/blob/main/supernote/server/README.mdd) for details.
 
 
 ### Access Supernote Services
@@ -128,36 +125,26 @@ async with SupernoteClient.from_credentials(email, password) as client:
 
 ```bash
 # Notebook operations
-supernote convert input.note output.pdf
-supernote analyze input.note
+supernote notebook convert input.note output.pdf
+supernote notebook analyze input.note
 
 # Server operations
-supernote-server serve
-supernote-server user add alice
-
+supernote serve
+supernote admin user list
+supernote admin user add email@example.com
 
 # Client operations
-supernote client login
-supernote client ls
+supernote cloud-login --url http://localhost:8080 email@example.com
+supernote cloud-ls
 ```
 
-## Development
-
-This package is designed for:
-1. **Server operators** - Self-hosting Supernote Private Cloud
-2. **Developers** - Integrating Supernote into applications
-3. **Reference** - Understanding Supernote protocols
-
-See [ARCHITECTURE.md](supernote/server/ARCHITECTURE.md) for protocol details.
+## Contributing
 
-### Setup
-
-```bash
-uv venv --python=3.14
-source .venv/bin/activate
-uv pip install -r requirements_dev.txt
-uv pip install -e ".[all]"
-```
+We welcome contributions! Please see our [Contributing Guide](docs/CONTRIBUTING.md) for details on:
+- Local development setup
+- Project architecture
+- Coding standards
+- Running tests
 
 ## Credits
 

{supernote-0.6.2 → supernote-0.8.0}/README.md

@@ -8,7 +8,7 @@ This content is shared between the [documentation](https://allenporter.github.io
 
 - **Notebook Parsing**: Convert `.note` files to PDF, PNG, SVG, or text
 - **Private Server**: Self-hosted Supernote Private Cloud implementation
-- **Client**: Interact with Supernote service API
+- **Client**: Interact with Supernote (Private) Cloud API
 
 ## Installation
 
@@ -23,16 +23,9 @@ pip install supernote[client]      # + Client
 pip install supernote[all]
 ```
 
-## Local Development
+## Local Development Setup
 
-Install in a virtual environment:
-
-```bash
-uv venv --python=3.14
-source .venv/bin/activate
-uv pip install -r requirements_dev.txt
-uv pip install -e ".[all]"
-```
+To set up the project for development, please refer to the [Contributing Guide](docs/CONTRIBUTING.md).
 
 ## Quick Start
 
@@ -49,38 +42,37 @@ The notebook parser is a fork and slightly lighter dependency version of [supern
 limitation. All credit goes to the original authors of [supernote-tool](https://github.com/jya-dev/supernote-tool) for providing an amazing low level utility.
 
 
-### Run Private Server
+### Server Setup & Bootstrap
 
-```bash
-# Generate configuration
-supernote-server config init > config.yaml
+1. **Start the Server**:
+   ```bash
+   supernote serve
+   ```
 
-# Generate users (outputs YAML, append to users.yaml)
-supernote-server user add alice >> users.yaml
+2. **Register the Admin**:
+   The first user registered becomes the system administrator.
+   ```bash
+   supernote admin user add email@example.com --url http://localhost:8080
+   ```
 
-# Start server
-supernote-server serve
-```
+3. **Login to CLI**:
+   ```bash
+   supernote cloud-login email@example.com --url http://localhost:8080
+   ```
+
+See the [Bootstrap Guide](docs/bootstrap_guide.md) for detailed deployment and security instructions.
 
 ### Run with Docker
 
 ```bash
 # Build image
-docker build -t supernote-server .
-
-# Generate initial configuration
-mkdir config
-docker run --rm supernote-server supernote-server config init > config/config.yaml
-docker run --rm -it supernote-server supernote-server user add alice >> config/users.yaml
+docker build -t supernote .
 
 # Run server
-docker run -d -p 8080:8080 \
-  -v $(pwd)/config:/config \
-  -v $(pwd)/storage:/data \
-  supernote-server
+docker run -d -p 8080:8080 -v $(pwd)/storage:/storage supernote serve
 ```
 
-See [Server Documentation](supernote/server/README.md) for details.
+See [Server Documentation](https://github.com/allenporter/supernote-lite/blob/main/supernote/server/README.mdd) for details.
 
 
 ### Access Supernote Services
@@ -98,36 +90,26 @@ async with SupernoteClient.from_credentials(email, password) as client:
 
 ```bash
 # Notebook operations
-supernote convert input.note output.pdf
-supernote analyze input.note
+supernote notebook convert input.note output.pdf
+supernote notebook analyze input.note
 
 # Server operations
-supernote-server serve
-supernote-server user add alice
-
+supernote serve
+supernote admin user list
+supernote admin user add email@example.com
 
 # Client operations
-supernote client login
-supernote client ls
+supernote cloud-login --url http://localhost:8080 email@example.com
+supernote cloud-ls
 ```
 
-## Development
-
-This package is designed for:
-1. **Server operators** - Self-hosting Supernote Private Cloud
-2. **Developers** - Integrating Supernote into applications
-3. **Reference** - Understanding Supernote protocols
-
-See [ARCHITECTURE.md](supernote/server/ARCHITECTURE.md) for protocol details.
+## Contributing
 
-### Setup
-
-```bash
-uv venv --python=3.14
-source .venv/bin/activate
-uv pip install -r requirements_dev.txt
-uv pip install -e ".[all]"
-```
+We welcome contributions! Please see our [Contributing Guide](docs/CONTRIBUTING.md) for details on:
+- Local development setup
+- Project architecture
+- Coding standards
+- Running tests
 
 ## Credits
 

{supernote-0.6.2 → supernote-0.8.0}/pyproject.toml

@@ -4,7 +4,7 @@ requires = ["setuptools>=77.0"]
 
 [project]
 name = "supernote"
-version = "0.6.2"
+version = "0.8.0"
 license = "Apache-2.0"
 license-files = ["LICENSE"]
 description = "All-in-one toolkit for Supernote devices: parse notebooks, self-host services, access services"
@@ -37,6 +37,11 @@ server = [
   "mashumaro>=3.17",
   "pyyaml>=6.0",
   "PyJWT>=2.10.1",
+  "SQLAlchemy[asyncio]>=2.0.0",
+  "alembic>=1.13.0",
+  "aiosqlite>=0.19.0",
+  "aiofiles>=25.1.0",
+  "aiohttp-remotes>=1.3.0",
 ]
 all = ["supernote[client,server]"]
 

{supernote-0.6.2 → supernote-0.8.0}/supernote/__init__.py

@@ -3,10 +3,10 @@
 """
 
 # Core notebook parsing (always available)
-from . import notebook
+from . import notebook  # noqa: F401
 
 __all__ = [
-    "notebook",
+    "models",
 ]
 
 # Optional: Client library
@@ -24,3 +24,5 @@ try:
     __all__.extend(["server"])
 except ImportError:
     pass
+
+__all__.extend(["notebook"])

supernote-0.8.0/supernote/cli/admin.py

@@ -0,0 +1,177 @@
+"""Admin CLI commands."""
+
+import asyncio
+import getpass
+import hashlib
+import sys
+
+from supernote.client.admin import AdminClient
+from supernote.client.exceptions import ApiException
+
+from .client import create_client
+
+
+async def add_user_async(
+    url: str, email: str, password: str, display_name: str | None = None
+):
+    """Async implementation of add user."""
+    async with create_client(url) as client:
+        print(f"Attempting to register user '{email}' on {client.host}...")
+
+        admin_client = AdminClient(client)
+
+        # Hash password
+        password_md5 = hashlib.md5(password.encode()).hexdigest()
+
+        # Try Public Registration
+        try:
+            await admin_client.register(
+                email=email,
+                password=password_md5,
+                username=display_name,
+            )
+            print("Success! User created (Public Registration).")
+            return
+        except ApiException:
+            # If failed, we don't have detailed status code in simple try/except unless we check exception type
+            # But client raises ApiException
+            pass
+
+        # Try Admin Creation API
+        print("Public registration failed or disabled. Attempting Admin creation...")
+        try:
+            await admin_client.admin_create_user(
+                email=email,
+                password=password_md5,
+                username=display_name,
+            )
+            print("Success! User created (Admin API).")
+        except Exception as e:
+            print(f"Admin creation failed: {e}")
+            sys.exit(1)
+
+
+async def list_users_async():
+    """Async implementation of list users."""
+    async with create_client() as client:
+        try:
+            users = await client.get_json("/api/admin/users", list)
+
+            print(f"\nTotal Users: {len(users)}\n")
+            print(f"{'Username':<30} {'Email':<30} {'Capacity':<10}")
+            print("-" * 75)
+            for u in users:
+                # users is a list of dicts if we passed list to get_json, or we need a VO
+                # client.get_json returns data_cls.from_json(result)
+                # But list doesn't have from_json.
+                # We should probably use raw get or define a List[UserVO] type if we can.
+                # For now let's just use raw request to get json list safely.
+                pass
+        except Exception:
+            pass
+
+        # Re-doing list fetch with raw request because of typing limitation in client.get_json for list[dict]
+        try:
+            resp = await client.get("/api/admin/users")
+            users = await resp.json()
+
+            print(f"\nTotal Users: {len(users)}\n")
+            print(f"{'Email':<30} {'Name':<20} {'Capacity':<10}")
+            print("-" * 65)
+            for u in users:
+                print(
+                    f"{u.get('email', 'N/A'):<30} {u.get('userName', 'N/A'):<20} {u.get('totalCapacity', '0'):<10}"
+                )
+
+        except Exception as e:
+            print(f"Failed to list users: {e}")
+
+
+def add_user(args):
+    password = args.password
+    if not password:
+        password = getpass.getpass(f"Password for {args.email}: ")
+
+    display_name = args.name or args.email.split("@")[0]
+    asyncio.run(add_user_async(args.url, args.email, password, display_name))
+
+
+def list_users(args):
+    asyncio.run(list_users_async())
+
+
+async def reset_password_async(url: str, email: str, password: str):
+    """Async implementation of password reset."""
+    async with create_client(url) as client:
+        print(f"Attempting to reset password for '{email}' on {client.host}...")
+        admin_client = AdminClient(client)
+
+        password_md5 = hashlib.md5(password.encode()).hexdigest()
+
+        try:
+            await admin_client.admin_reset_password(email, password_md5)
+            print("Success! Password Reset.")
+        except Exception as e:
+            print(f"Failed to reset password: {e}")
+            sys.exit(1)
+
+
+def reset_password(args):
+    password = args.password
+    if not password:
+        password = getpass.getpass(f"New password for {args.email}: ")
+        confirm = getpass.getpass("Confirm password: ")
+        if password != confirm:
+            print("Passwords do not match.")
+            sys.exit(1)
+
+    asyncio.run(reset_password_async(args.url, args.email, password))
+
+
+def add_parser(subparsers):
+    # 'admin' parent command
+    parser_admin = subparsers.add_parser(
+        "admin",
+        help="Administrative commands for Supernote Server",
+    )
+    parser_admin.add_argument("--url", type=str, help="URL of the Supernote Server")
+
+    admin_subparsers = parser_admin.add_subparsers(dest="admin_command")
+
+    # --- User Management ---
+    parser_user = admin_subparsers.add_parser("user", help="User management commands")
+    user_subparsers = parser_user.add_subparsers(dest="user_command")
+
+    # user list
+    parser_user_list = user_subparsers.add_parser(
+        "list",
+        help="List all users",
+    )
+    parser_user_list.set_defaults(func=list_users)
+
+    # user add
+    parser_user_add = user_subparsers.add_parser(
+        "add",
+        help="Add a new user",
+    )
+    parser_user_add.add_argument(
+        "email", type=str, help="Email address for the new user"
+    )
+    parser_user_add.add_argument(
+        "--password", type=str, help="Password (if omitted, prompt interactively)"
+    )
+    parser_user_add.add_argument(
+        "--name", type=str, help="Display name (optional)", default=None
+    )
+    parser_user_add.set_defaults(func=add_user)
+
+    # user reset-password
+    parser_user_reset = user_subparsers.add_parser(
+        "reset-password",
+        help="Reset user password",
+    )
+    parser_user_reset.add_argument("email", type=str, help="Email address of the user")
+    parser_user_reset.add_argument(
+        "--password", type=str, help="New password (if omitted, prompt interactively)"
+    )
+    parser_user_reset.set_defaults(func=reset_password)