Tripleflow

Tripleflow is a tool that enables semi-supervised data feeding of knowledge graphs from unstructured documents.

Table of contents

• Tripleflow
  • Table of contents
  • Quick start
    • System requirements
    • Configuration
    • Installation and launch with Python and Vue.js
    • Installation and launch with Docker
  • Bugs and feature requests
  • Contributing
  • Versioning
  • Copyright and license

Quick start

System requirements

• Python 3.11 or higher.
• Node / NPM
• Docker
• Make
• MongoDB instance

Configuration

Both services read their settings from environment files. Copy the templates and fill in your values before the first launch:

cp tripleflow-api/.env.template tripleflow-api/.env
cp tripleflow-front/.env.template tripleflow-front/.env.local

MONGO_URI is required, the API fails to start without it. Every other variable is optional and documented in the templates.

Installation and launch with Python and Vue.js

1. Dependency installation

We recommend a virtual environment to avoid dependency conflicts.

cd tripleflow-api && python3 -m venv .venv && source .venv/bin/activate && pip install -r requirements.txt

cd tripleflow-front && npm install

1. Launch app

Run each service in its own terminal, so the API and the front-end stay up at the same time (MongoDB must already be running too):

cd tripleflow-api && uvicorn app.main:app

cd tripleflow-front && npm install && npm run dev

Installation and launch with Docker

1. API

cd tripleflow-api && make docker-build

cd tripleflow-api && make docker-run

2. Front

cd tripleflow-front && make docker-build

cd tripleflow-front && make docker-run

Bugs and feature requests

Have a bug or a feature request? Please first read the issue guidelines and search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

Contributing

Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.

Please refer to the [quick start] for information on how to launch the application.

Versioning

For transparency into our release cycle and in striving to maintain backward compatibility, Tripleflow is maintained under the Semantic Versioning guidelines. Sometimes we screw up, but we adhere to those rules whenever possible.

See the Releases section of our GitHub project for changelogs for each release version of Tripleflow.

The release management process is decided in the RELEASE.md of the gh-pages branch

Copyright and license

Code released under the MIT License.