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

Uploaded Python 3

File details

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

File metadata

  • Download URL: fieldz_kb-0.2.0.tar.gz
  • Upload date:
  • Size: 94.3 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.0.tar.gz
Algorithm Hash digest
SHA256 6cb6dbf5a0993ff930c88c18ee33c9e708657a488f75f2a526025c05e6871350
MD5 5ba827b6080a1a9a55fc4f93b9183198
BLAKE2b-256 0b57cb21d7ea272694c26b9d3a874e09f33b7d1779192cd278b6619d6581e573

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: fieldz_kb-0.2.0-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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5c53486a56db100946368943c79bd93af705d095487f07d37b8a888e932adc9e
MD5 1985c64a303231df860383a2be93fe36
BLAKE2b-256 761da99ba1e9f01d8acec50b6cbe89681c06c6e2d326bb7a28f3a7dae278c7e8

See more details on using hashes here.

Provenance

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