Sinapsis ApertureDB

Modular templates for database entity management with ApertureDB

🐍 Installation • 🚀 Features • 📚 Usage example • 🌐 Webapp • 📙 Documentation • 🔍 License

Sinapsis ApertureDB provides a robust and flexible integration for the ApertureDB Python SDK. It enables users to execute complex database operations—such as entity management, status monitoring, and schema retrieval—through a modular, template-based system.

🐍 Installation

Install using your package manager of choice. We encourage the use of uv

Example with uv:

  uv pip install sinapsis-aperturedb --extra-index-url https://pypi.sinapsis.tech

or with raw pip:

  pip install sinapsis-aperturedb --extra-index-url https://pypi.sinapsis.tech

🚀 Features

Templates Supported

• ApertureDBAddEntitiesFromCSV: Ingests tabular data from a pandas DataFrame stored within a DataContainer, mapping each row to a unique Entity for bulk insertion into the database.
• ApertureDBFindEntities: Executes targeted entity queries within ApertureDB, retrieving records that match a specific set of user-defined constraints and filters.
• ApertureDBGetStatus: Polls the ApertureDB server to retrieve real-time health metrics, connectivity status, and operational readiness.
• ApertureDBGetSchema: Introspects the database to generate a comprehensive overview of the current data model, including entity types, properties, and relationships.

[!TIP] Use CLI command sinapsis info --all-template-names to show a list with all the available Template names installed with Sinapsis ApertureDB.

[!TIP] Use CLI command sinapsis info --example-template-config TEMPLATE_NAME to produce an example Agent config for the Template specified in TEMPLATE_NAME.

For example, for ApertureDBGetStatus use sinapsis info --example-template-config ApertureDBGetStatus to produce an example config like:

agent:
  name: my_test_agent
templates:
- template_name: InputTemplate
  class_name: InputTemplate
  attributes: {}
- template_name: ApertureDBGetStatus
  class_name: ApertureDBGetStatus
  template_input: InputTemplate
  attributes:
    connect_with_key: false
    connection_params:
      host: localhost
      user: ''
      port: 55555
      password: ''
      key: ''
      use_ssl: false

📚 Usage example

You can begin testing sinapsis-aperturedb by executing the ApertureDBGetStatus configuration. To utilize the ApertureDB templates, you must first establish a connection to an ApertureDB instance. You have three primary options:

• Cloud: Connect to a hosted ApertureDB instance using a generated API key.
• Local: Deploy a local instance using the aperturedb-community Docker image.
• Docker Compose: Automatically deploy the aperturedb service and execute the getStatus configuration in one workflow.

📙 Documentation

Documentation for this and other sinapsis packages is available on the sinapsis website

Tutorials for different projects within sinapsis are available at sinapsis tutorials page

🔍 License

This project is licensed under the AGPLv3 license, which encourages open collaboration and sharing. For more details, please refer to the LICENSE file.

For commercial use, please refer to our official Sinapsis website for information on obtaining a commercial license.