Metadata-Version: 2.4
Name: ckanext-knowledge-assistant
Version: 0.2.0
Summary: RAG-based knowledge assistant for CKAN - intelligent semantic search using natural language queries
Author-email: DataShades <datashades@linkdigital.com.au>
License: AGPL
Project-URL: Homepage, https://github.com/DataShades/ckanext-knowledge-assistant
Keywords: CKAN,RAG,semantic-search,knowledge-assistant,llama-index
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: llama-index-core
Requires-Dist: llama-index-llms-ollama
Requires-Dist: llama-index-llms-openai
Requires-Dist: llama-index-tools-mcp
Requires-Dist: llama-index-vector-stores-postgres
Requires-Dist: llama-index-embeddings-ollama
Requires-Dist: llama-index-embeddings-openai
Requires-Dist: llama-index-readers-file
Requires-Dist: docx2txt
Requires-Dist: pypdf
Provides-Extra: docs
Requires-Dist: mkdocs; extra == "docs"
Requires-Dist: mkdocs-material; extra == "docs"
Requires-Dist: mkdocstrings; extra == "docs"
Requires-Dist: mkdocstrings-python; extra == "docs"
Requires-Dist: pymdown-extensions; extra == "docs"
Requires-Dist: mkdocs-macros-plugin; extra == "docs"
Dynamic: license-file

[![Tests](https://github.com/DataShades/ckanext-knowledge-assistant/actions/workflows/test.yml/badge.svg)](https://github.com/DataShades/ckanext-knowledge-assistant/actions/workflows/test.yml)

# ckanext-knowledge-assistant

An AI-powered knowledge assistant for CKAN that helps you work with dataset and resource data, featuring semantic search capabilities and natural language interactions.

See the [documentation](https://datashades.github.io/ckanext-knowledge-assistant//) for more information.

## Requirements

- CKAN >= 2.10
- Python >= 3.10
- PostgreSQL with pgvector extension
- Ollama (for local models) OR OpenAI API key

Compatibility with core CKAN versions:

| CKAN version    | Compatible?   |
| --------------- | ------------- |
| 2.9 and earlier | no.           |
| 2.10            | not tested    |
| 2.11            | yes           |

## Tests

To run the tests, do:
```bash
pytest --ckan-ini=test.ini
```

## License

[AGPL](https://www.gnu.org/licenses/agpl-3.0.en.html)
