paramus-world


Nameparamus-world JSON
Version 1.0.2 PyPI version JSON
download
home_pagehttps://paramus.ai/paramus-world/
SummaryParamus World Client - API client for the Paramus World semantic knowledge graph system
upload_time2025-07-28 14:50:44
maintainerNone
docs_urlNone
authorThorsten Gressling
requires_python>=3.8
licenseProprietary
keywords semantic api knowledge graph sparql json-rpc paramus world client api
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Paramus World Client

A Python client library for interacting with the Paramus World semantic knowledge graph system.

## Features

- **JSON-RPC API Client**: Easy-to-use client for Paramus World API
- **SPARQL Support**: Execute SPARQL queries and updates against the knowledge graph
- **Chat Interface**: Submit messages to the AI assistant
- **Health Monitoring**: Check system status and statistics
- **Authentication**: JWT token-based authentication

## Installation

```bash
pip install paramus-world
```

## Quick Start

```python
from paramus.world.client import ParamusWorldClient

# Initialize the client
client = ParamusWorldClient(token="your-jwt-token")

# Check system health
health = client.check_system_health()
print(health)

# Submit a chat message
response = client.submit_chat("Hello, World!")
print(response)

# Execute a SPARQL query
query = """
PREFIX world: <https://paramus.ai/world/>
SELECT ?subject ?predicate ?object
WHERE { ?subject ?predicate ?object }
LIMIT 10
"""
result = client.sparql_query(query)
print(result)
```

## API Methods

### Authentication
- `authenticate(username, password)` - Authenticate and get a token

### Chat Interface  
- `submit_chat(message, context=None)` - Submit a message to the AI assistant

### SPARQL Operations
- `sparql_query(query, format="json")` - Execute SPARQL queries
- `sparql_update(update)` - Execute SPARQL updates

### System Monitoring
- `check_system_health()` - Get system health and statistics

## Configuration

The client connects to `http://127.0.0.1:8051` by default. You can configure this:

```python
client = ParamusWorldClient(
    base_url="https://your-server.com",
    token="your-jwt-token"
)
```

## Examples

See the [examples](https://github.com/gressling/paramus-world-client/tree/main/examples) directory for comprehensive usage examples.

## License

MIT License - see [LICENSE](LICENSE) file for details.

## Links

- **Repository**: https://github.com/gressling/paramus-world-client
- **Documentation**: https://paramus-world-client.readthedocs.io/
- **Issues**: https://github.com/gressling/paramus-world-client/issues

            

Raw data

            {
    "_id": null,
    "home_page": "https://paramus.ai/paramus-world/",
    "name": "paramus-world",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "semantic API, knowledge graph, SPARQL, JSON-RPC, paramus, world, client, api",
    "author": "Thorsten Gressling",
    "author_email": "Thorsten Gressling <gressling@paramus.ai>",
    "download_url": "https://files.pythonhosted.org/packages/d7/80/fda9c688f48d1f5a27bfe985cb1c86f3f1182eb81baeff5a84f0b376455d/paramus_world-1.0.2.tar.gz",
    "platform": null,
    "description": "# Paramus World Client\n\nA Python client library for interacting with the Paramus World semantic knowledge graph system.\n\n## Features\n\n- **JSON-RPC API Client**: Easy-to-use client for Paramus World API\n- **SPARQL Support**: Execute SPARQL queries and updates against the knowledge graph\n- **Chat Interface**: Submit messages to the AI assistant\n- **Health Monitoring**: Check system status and statistics\n- **Authentication**: JWT token-based authentication\n\n## Installation\n\n```bash\npip install paramus-world\n```\n\n## Quick Start\n\n```python\nfrom paramus.world.client import ParamusWorldClient\n\n# Initialize the client\nclient = ParamusWorldClient(token=\"your-jwt-token\")\n\n# Check system health\nhealth = client.check_system_health()\nprint(health)\n\n# Submit a chat message\nresponse = client.submit_chat(\"Hello, World!\")\nprint(response)\n\n# Execute a SPARQL query\nquery = \"\"\"\nPREFIX world: <https://paramus.ai/world/>\nSELECT ?subject ?predicate ?object\nWHERE { ?subject ?predicate ?object }\nLIMIT 10\n\"\"\"\nresult = client.sparql_query(query)\nprint(result)\n```\n\n## API Methods\n\n### Authentication\n- `authenticate(username, password)` - Authenticate and get a token\n\n### Chat Interface  \n- `submit_chat(message, context=None)` - Submit a message to the AI assistant\n\n### SPARQL Operations\n- `sparql_query(query, format=\"json\")` - Execute SPARQL queries\n- `sparql_update(update)` - Execute SPARQL updates\n\n### System Monitoring\n- `check_system_health()` - Get system health and statistics\n\n## Configuration\n\nThe client connects to `http://127.0.0.1:8051` by default. You can configure this:\n\n```python\nclient = ParamusWorldClient(\n    base_url=\"https://your-server.com\",\n    token=\"your-jwt-token\"\n)\n```\n\n## Examples\n\nSee the [examples](https://github.com/gressling/paramus-world-client/tree/main/examples) directory for comprehensive usage examples.\n\n## License\n\nMIT License - see [LICENSE](LICENSE) file for details.\n\n## Links\n\n- **Repository**: https://github.com/gressling/paramus-world-client\n- **Documentation**: https://paramus-world-client.readthedocs.io/\n- **Issues**: https://github.com/gressling/paramus-world-client/issues\n",
    "bugtrack_url": null,
    "license": "Proprietary",
    "summary": "Paramus World Client - API client for the Paramus World semantic knowledge graph system",
    "version": "1.0.2",
    "project_urls": {
        "Documentation": "https://paramus-world-client.readthedocs.io/en/latest/",
        "Homepage": "https://paramus.ai/paramus-world/",
        "Issues": "https://github.com/gressling/paramus-world-client/issues",
        "Repository": "https://github.com/gressling/paramus-world-client"
    },
    "split_keywords": [
        "semantic api",
        " knowledge graph",
        " sparql",
        " json-rpc",
        " paramus",
        " world",
        " client",
        " api"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "d9287eaff480f74668202470b6be0aeec96ca637b55a252e0e0283e287e759e9",
                "md5": "53c34f409d2032c6a54c7aa4d94a43ff",
                "sha256": "ca1844f27379dc439ac3e249938fb90cf2ed79c15caebfea8bdbeb7e525acebc"
            },
            "downloads": -1,
            "filename": "paramus_world-1.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "53c34f409d2032c6a54c7aa4d94a43ff",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 5031,
            "upload_time": "2025-07-28T14:50:43",
            "upload_time_iso_8601": "2025-07-28T14:50:43.407533Z",
            "url": "https://files.pythonhosted.org/packages/d9/28/7eaff480f74668202470b6be0aeec96ca637b55a252e0e0283e287e759e9/paramus_world-1.0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "d780fda9c688f48d1f5a27bfe985cb1c86f3f1182eb81baeff5a84f0b376455d",
                "md5": "e3777ef86dbcb3581fd9de688fc1a554",
                "sha256": "f0f0cbaecb7c2ee665393e63150e1ffac8382a6699db079cfd09eaa2a410dc37"
            },
            "downloads": -1,
            "filename": "paramus_world-1.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "e3777ef86dbcb3581fd9de688fc1a554",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 29840,
            "upload_time": "2025-07-28T14:50:44",
            "upload_time_iso_8601": "2025-07-28T14:50:44.435053Z",
            "url": "https://files.pythonhosted.org/packages/d7/80/fda9c688f48d1f5a27bfe985cb1c86f3f1182eb81baeff5a84f0b376455d/paramus_world-1.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-28 14:50:44",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "gressling",
    "github_project": "paramus-world-client",
    "github_not_found": true,
    "lcname": "paramus-world"
}
        
Elapsed time: 1.67687s