Skip to main content

A library store dataclass-like objects into knowledge bases

Project description

fieldz_kb

A library to store dataclass-like objects into knowledge bases.

Features

  • Multiple backends — Neo4j, FalkorDB, FalkorDBLite (embedded), clingo/ASP
  • Automatic type conversion — primitives, collections, enums, nested dataclasses
  • Plugin-based extensibility — add support for custom types
  • BioCypher integration — generate BioCypher-compatible nodes, relationships, and YAML schemas

Installation

pip install fieldz-kb[neo4j]        # Neo4j support
pip install fieldz-kb[falkordb]     # FalkorDB support
pip install fieldz-kb[falkordblite] # FalkorDBLite (embedded) support
pip install fieldz-kb[clingo]       # Clingo/ASP support
pip install fieldz-kb[biocypher]    # BioCypher adapter
pip install fieldz-kb[all]          # Everything

Quick example

import dataclasses
import fieldz_kb.lpg.session
import fieldz_kb.lpg.backends.neo4j

@dataclasses.dataclass
class Gene:
    name: str
    chromosome: int

backend = fieldz_kb.lpg.backends.neo4j.Neo4jBackend(
    hostname="localhost",
    username="neo4j",
    password="password",
)

with fieldz_kb.lpg.session.Session(backend) as session:
    session.save_from_object(Gene(name="TP53", chromosome=17))

    results = session.execute_query_as_objects(
        "MATCH (n:Gene) RETURN n"
    )

Documentation

Full documentation is available at https://adrienrougny.github.io/fieldz_kb/.

License

GPLv3. See LICENSE for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fieldz_kb-0.2.4.tar.gz (97.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fieldz_kb-0.2.4-py3-none-any.whl (27.5 kB view details)

Uploaded Python 3

File details

Details for the file fieldz_kb-0.2.4.tar.gz.

File metadata

  • Download URL: fieldz_kb-0.2.4.tar.gz
  • Upload date:
  • Size: 97.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for fieldz_kb-0.2.4.tar.gz
Algorithm Hash digest
SHA256 bef120b7d796617ab6f7b7d7a99f6a02fcecfebff342de8db556668d05ddc5b3
MD5 fb625d51cb801e1b26f9ae5e2abd586b
BLAKE2b-256 fde2ca64d115ec0e46a10e032bb8125e8cb04ae0dced4c05fd5d30c9664cbc6c

See more details on using hashes here.

Provenance

The following attestation bundles were made for fieldz_kb-0.2.4.tar.gz:

Publisher: release.yml on adrienrougny/fieldz_kb

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file fieldz_kb-0.2.4-py3-none-any.whl.

File metadata

  • Download URL: fieldz_kb-0.2.4-py3-none-any.whl
  • Upload date:
  • Size: 27.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for fieldz_kb-0.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 8b9b075fed803403caafebd62615db9a2c93437a021add8469f49fadeda45d47
MD5 3d22b0ac96c30de456a92308cf55c092
BLAKE2b-256 57f077af8b398163a27231a4a154c9321a70dba296c9a1c2405320b04418a2dd

See more details on using hashes here.

Provenance

The following attestation bundles were made for fieldz_kb-0.2.4-py3-none-any.whl:

Publisher: release.yml on adrienrougny/fieldz_kb

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page