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.1.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.1-py3-none-any.whl (27.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: fieldz_kb-0.2.1.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.1.tar.gz
Algorithm Hash digest
SHA256 68331ba7b7f18755e5d83339fca1a43cddfc77fc08aa0045d39b1809bcd5e2c6
MD5 3bf64180b8eeb4858ce2b41523e6d7a8
BLAKE2b-256 321c86edcb16f339190f1626a7abf5fdc5e4092be6383f51a163e33ff17488b7

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: fieldz_kb-0.2.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 cbf4cad0349539688e70a77ea005fbdd4a30e24b5b763ce6958bbd319d940166
MD5 b7a6d7601a030ad99ed4d8dff6bd8672
BLAKE2b-256 044141252a3f3981e2d183abcd36a298579fd6db2e7f3463a8edd65d0375f802

See more details on using hashes here.

Provenance

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