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

Uploaded Python 3

File details

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

File metadata

  • Download URL: fieldz_kb-0.2.3.tar.gz
  • Upload date:
  • Size: 95.4 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.3.tar.gz
Algorithm Hash digest
SHA256 4d4007a359926b7a195e5cf21fddc7d962f834272dab70b3da2fec23a4ef6918
MD5 a6b46c95d444f85d7f9e5a8a546a6cd0
BLAKE2b-256 5dcb31427087f67e8c51933902df1130420eab873e2821d49a673af646ad3f4d

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: fieldz_kb-0.2.3-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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 8def60553efc9f93e8793c884f8c4536c1111745fd02b45d55fc4433727fba57
MD5 247eeeec3a72d5c5ab0200884cafc49d
BLAKE2b-256 e6b2c7b1a7256f7599d08e9af496c8873eba3a1cad34f62a777674039dfac4fe

See more details on using hashes here.

Provenance

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