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.2.tar.gz (95.0 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.2-py3-none-any.whl (27.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: fieldz_kb-0.2.2.tar.gz
  • Upload date:
  • Size: 95.0 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.2.tar.gz
Algorithm Hash digest
SHA256 9de7169133811fd2789b77220977b7bcc1642f2a29ee5378985ff4efd9cf2459
MD5 7cb634738026ef843c12fc95c00727e7
BLAKE2b-256 628d49c98e79f5c0dab904287eab6624872ac71e63f0caeadf9d7d64a0300f18

See more details on using hashes here.

Provenance

The following attestation bundles were made for fieldz_kb-0.2.2.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.2-py3-none-any.whl.

File metadata

  • Download URL: fieldz_kb-0.2.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 e156d65fc72664416c3962b7385c71cd4cd682221c9858e735edfc5d47127dba
MD5 b8d5b7126199ba511b976dc57c88b393
BLAKE2b-256 417432b6b59ae7bcdad26fffb47b5d1cf75bafbae8c01e1aed99cec036a68b2c

See more details on using hashes here.

Provenance

The following attestation bundles were made for fieldz_kb-0.2.2-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