Metadata-Version: 2.4
Name: prometheux_chain
Version: 0.2.12
Summary: Prometheux chain is a Python SDK designed to build, evolve and deploy your new knowledge graphs.
Home-page: https://github.com/prometheuxresearch/prometheux_chain
Author: Prometheux Limited
Author-email: davben@prometheux.co.uk
License: BSD-3-Clause
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests
Requires-Dist: pyyaml
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# Prometheux_chain

## Description
Prometheux Chain is a Python SDK designed to help you create, evolve, and deploy knowledge graphs with ease. The SDK offers the following capabilities:

- Data Ingestion: Seamlessly integrate data from various sources, including databases and files.
- Reasoning & Knowledge Augmentation: Perform logical reasoning to derive new insights and augment your existing knowledge base.
- Explainability: Gain clear explanations of the results generated by the system.

For more information refer to the [documentation](https://docs.prometheux.ai/sdk)

## Features
- Supports a wide range of data sources.
- Built-in reasoning engine for deriving new knowledge.
- Easy-to-understand explanations for enhanced interpretability.
- Ready-to-use configurations for fast deployment.

## Installation

### Requirements
- Python 3.9 or higher (Python 3.13 recommended)

### Install Using pip

1. Set Up a Virtual Environment (recommended):

```bash
python3 -m venv myenv
source myenv/bin/activate  # On Windows: myenv\Scripts\activate
```

2. Install the SDK via pip:

```
pip install --upgrade prometheux_chain
```

## Usage

This guide demonstrates how to get started with the Prometheux Chain SDK. The example below outlines a typical workflow, including creating a project, defining concept logic, and running concepts to generate results.

### Workflow

#### Import the `prometheux_chain`
```python
import prometheux_chain as px
import os
```

#### Define the PMTX_TOKEN environment variable for authentication
```python
os.environ['PMTX_TOKEN'] = 'my_pmtx_token'
```

#### Configure the backend connection using your Prometheux account
```python
px.config.set('JARVISPY_URL', "https://platform.prometheux.ai/jarvispy/'my_organization'/'my_username'")
```

#### Create a new project
```python
project_id = px.save_project(project_name="test_project")
```

#### Define concept logic using Vadalog syntax and save it
```python
concept_logic = """
company("Apple", "Redwood City, CA").
company("Google", "Mountain View, CA").
company("Microsoft", "Redmond, WA").
company("Amazon", "Seattle, WA").
company("Facebook", "Menlo Park, CA").
company("Twitter", "San Francisco, CA").
company("LinkedIn", "Sunnyvale, CA").
company("Instagram", "Menlo Park, CA").

location(Location) :- company(_,Location).

@output("location").
"""
px.save_concept(project_id=project_id, concept_logic=concept_logic)
```

#### Run the concept to generate results
```python
px.run_concept(project_id=project_id, concept_name="location")
```

---

## Access to Prometheux Backend

The Prometheux backend is required to use this SDK. To request access:

- 📧 **Email**: davben@prometheux.co.uk or support@prometheux.co.uk
- 🌐 **Website**: https://www.prometheux.ai

## License

BSD 3-Clause License — see [LICENSE](LICENSE) file for details.

## About Prometheux

Prometheux is an **ontology native data engine** that processes data anywhere it lives. Define ontologies once and unlock knowledge that spans databases, warehouses, and platforms—built on the Vadalog reasoning engine.

**Key capabilities:**
- **Connect**: Query across Snowflake, Databricks, Neo4j, SQL, CSV, and more without ETL or vendor lock-in
- **Think**: Replace 100+ lines of PySpark/SQL with simple declarative logic. Power graph analytics without GraphDBs
- **Explain**: Full lineage & traceability with deterministic, repeatable results. Ground AI in structured, explainable context

Exponentially faster and simpler than traditional approaches. Learn more at [prometheux.ai](https://prometheux.ai/).

## Support

For issues, questions, or access requests:

- **Homepage**: https://www.prometheux.ai
- **PyPI**: https://pypi.org/project/prometheux-chain/
- **Email**: davben@prometheux.co.uk or support@prometheux.co.uk
- **Documentation**: https://docs.prometheux.ai/sdk
- **Issues**: [GitHub Issues](https://github.com/prometheuxresearch/prometheux_chain/issues)

## Related Projects

- [Prometheux MCP](https://pypi.org/project/prometheux-mcp/) — MCP client for AI agents
- [Vadalog Extension](https://pypi.org/project/vadalog-extension/) — JupyterLab extension for Vadalog
- [Vadalog Jupyter Kernel](https://pypi.org/project/vadalog-jupyter-kernel/) — Jupyter kernel for Vadalog
