Metadata-Version: 2.3
Name: acdh-cfts-pyutils
Version: 1.0.0
Summary: Python Package to interact with the CFTS-Collection
Author: Peter Andorfer
Author-email: Peter Andorfer <peter.andorfer@oeaw.ac.at>
Requires-Dist: typesense>=2.0.0
Requires-Python: >=3.11
Project-URL: Repository, https://github.com/acdh-oeaw/acdh-cfts-pyutils.git
Description-Content-Type: text/markdown

[![Test](https://github.com/acdh-oeaw/acdh-cfts-pyutils/actions/workflows/test.yml/badge.svg)](https://github.com/acdh-oeaw/acdh-cfts-pyutils/actions/workflows/test.yml)
[![PyPI version](https://badge.fury.io/py/acdh-cfts-pyutils.svg)](https://badge.fury.io/py/acdh-cfts-pyutils)
[![Lint](https://github.com/acdh-oeaw/acdh-cfts-pyutils/actions/workflows/lint.yml/badge.svg)](https://github.com/acdh-oeaw/acdh-cfts-pyutils/actions/workflows/lint.yml)

# acdh-cfts-pyutils

Python Package to interact with a dedicated Typesense Server and Collection

* This package exposes some constants to interact with a dedicated Typesense Server and Collection through other Python scripts.
* Also this package is inteded to be the one and only place to modifiy the schema of the given centralised collection

## install

* run `uv add install acdh-cfts-pyutils`
* adapt/modifiy environmet variables to fit you needs. See `env.default` for example. If you use this package to populate the ACDH-CH central fulltext search collection running on ACDH-CH's own Typesense-Server, you'll only need to set `TYPESENSE_API_KEY` via an environment varibale.
