links-client 1.0.0__tar.gz

links_client-1.0.0/PKG-INFO

@@ -0,0 +1,141 @@
+Metadata-Version: 2.4
+Name: links-client
+Version: 1.0.0
+Summary: Python client library for link-cli (Links Theory database)
+Author: DronDoc Team
+License: Unlicense
+Project-URL: Homepage, https://github.com/link-foundation/links-client
+Project-URL: Repository, https://github.com/link-foundation/links-client
+Project-URL: Issues, https://github.com/link-foundation/links-client/issues
+Keywords: link-cli,links-theory,database,associative,clink
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: Public Domain
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
+
+# Links Client - Python Implementation
+
+Python client library for [link-cli](https://github.com/link-foundation/link-cli) — implementation of Links Theory database.
+
+## Installation
+
+### Prerequisites
+
+Install link-cli globally:
+```bash
+dotnet tool install --global clink
+```
+
+### Package Installation
+
+```bash
+pip install -e .
+```
+
+Or install from the repository root:
+
+```bash
+cd python
+pip install -e .
+```
+
+## Usage
+
+### Basic Usage
+
+```python
+from links_client import LinkDBService
+
+db = LinkDBService('/path/to/database.links')
+
+# Create a link
+link = db.create_link(100, 200)
+print(link)  # {'id': 1, 'source': 100, 'target': 200}
+
+# Read all links
+links = db.read_all_links()
+
+# Delete a link
+db.delete_link(1)
+```
+
+### Menu Storage
+
+```python
+from links_client import MenuStorageService
+
+menu_storage = MenuStorageService()
+
+menu = [
+    {
+        "label": "Dashboard",
+        "icon": "pi pi-home",
+        "to": "/dashboard",
+        "items": [
+            {"label": "Analytics", "to": "/dashboard/analytics"}
+        ]
+    }
+]
+
+menu_storage.store_menu_structure(menu, 0)
+retrieved_menu = menu_storage.get_menu_structure(0)
+```
+
+### Authentication Storage
+
+```python
+from links_client import AuthStorageService
+
+auth_storage = AuthStorageService()
+
+# Create user
+user = auth_storage.create_user({
+    "username": "alice",
+    "email": "alice@example.com"
+})
+
+# Set password
+auth_storage.set_password(user['userId'], {
+    "hash": "hashed_password",
+    "salt": "random_salt"
+})
+```
+
+## API
+
+For detailed API documentation, see the docs/ directory.
+
+## Examples
+
+See examples in the examples/ directory:
+
+- `basic_usage.py` - Basic clink integration tests
+- `menu_storage_example.py` - Menu storage demonstration
+- `auth_storage_example.py` - Authentication storage demonstration
+
+## Testing
+
+Run tests with pytest:
+
+```bash
+pytest tests/
+```
+
+## License
+
+The Unlicense
+
+## Links
+
+- Source repository: https://github.com/link-foundation/links-client
+- link-cli: https://github.com/link-foundation/link-cli

links_client-1.0.0/README.md

@@ -0,0 +1,116 @@
+# Links Client - Python Implementation
+
+Python client library for [link-cli](https://github.com/link-foundation/link-cli) — implementation of Links Theory database.
+
+## Installation
+
+### Prerequisites
+
+Install link-cli globally:
+```bash
+dotnet tool install --global clink
+```
+
+### Package Installation
+
+```bash
+pip install -e .
+```
+
+Or install from the repository root:
+
+```bash
+cd python
+pip install -e .
+```
+
+## Usage
+
+### Basic Usage
+
+```python
+from links_client import LinkDBService
+
+db = LinkDBService('/path/to/database.links')
+
+# Create a link
+link = db.create_link(100, 200)
+print(link)  # {'id': 1, 'source': 100, 'target': 200}
+
+# Read all links
+links = db.read_all_links()
+
+# Delete a link
+db.delete_link(1)
+```
+
+### Menu Storage
+
+```python
+from links_client import MenuStorageService
+
+menu_storage = MenuStorageService()
+
+menu = [
+    {
+        "label": "Dashboard",
+        "icon": "pi pi-home",
+        "to": "/dashboard",
+        "items": [
+            {"label": "Analytics", "to": "/dashboard/analytics"}
+        ]
+    }
+]
+
+menu_storage.store_menu_structure(menu, 0)
+retrieved_menu = menu_storage.get_menu_structure(0)
+```
+
+### Authentication Storage
+
+```python
+from links_client import AuthStorageService
+
+auth_storage = AuthStorageService()
+
+# Create user
+user = auth_storage.create_user({
+    "username": "alice",
+    "email": "alice@example.com"
+})
+
+# Set password
+auth_storage.set_password(user['userId'], {
+    "hash": "hashed_password",
+    "salt": "random_salt"
+})
+```
+
+## API
+
+For detailed API documentation, see the docs/ directory.
+
+## Examples
+
+See examples in the examples/ directory:
+
+- `basic_usage.py` - Basic clink integration tests
+- `menu_storage_example.py` - Menu storage demonstration
+- `auth_storage_example.py` - Authentication storage demonstration
+
+## Testing
+
+Run tests with pytest:
+
+```bash
+pytest tests/
+```
+
+## License
+
+The Unlicense
+
+## Links
+
+- Source repository: https://github.com/link-foundation/links-client
+- link-cli: https://github.com/link-foundation/link-cli

links_client-1.0.0/links_client/__init__.py

@@ -0,0 +1,22 @@
+"""
+Links Client - Python client library for link-cli (Links Theory database)
+
+This package provides a Python interface to the link-cli (clink) tool for
+working with Links Theory databases.
+"""
+
+from links_client.services.link_db_service import LinkDBService
+from links_client.services.menu_storage_service import MenuStorageService
+from links_client.services.auth_storage_service import AuthStorageService
+from links_client.api.ilinks import ILinks, LinkConstants
+from links_client.api.recursive_links import RecursiveLinks
+
+__version__ = "1.0.0"
+__all__ = [
+    "LinkDBService",
+    "MenuStorageService",
+    "AuthStorageService",
+    "ILinks",
+    "LinkConstants",
+    "RecursiveLinks"
+]

links_client-1.0.0/links_client/services/__init__.py

@@ -0,0 +1,7 @@
+"""Services for interacting with link-cli database"""
+
+from links_client.services.link_db_service import LinkDBService
+from links_client.services.menu_storage_service import MenuStorageService
+from links_client.services.auth_storage_service import AuthStorageService
+
+__all__ = ["LinkDBService", "MenuStorageService", "AuthStorageService"]