The Python code powering the TEDective API

Go to file

Linus Sehn dc7d0982b2 All checks were successful Deploy Nix Flake / deploy-nix-flake (push) Successful in 1s Details fix: set default start_date and end_date for graph query		2024-06-17 21:10:54 +02:00
.gitea/workflows	fix: trigger the workflow	2024-05-24 10:25:11 +00:00
.vscode	feat: better logging	2024-02-09 14:32:05 +01:00
docs	git subrepo push docs	2024-01-30 12:21:42 +01:00
tedective_api	fix: set default start_date and end_date for graph query	2024-06-17 21:10:54 +02:00
tests	fix: path for graph tests	2024-05-24 11:42:07 +02:00
.envrc	feat: start fresh with nix instead of docker	2024-01-30 12:05:21 +01:00
.gitignore	fix: removed .idea/ and small tweak to tender endpoints	2024-04-16 18:16:05 +02:00
flake.lock	fix: Stack overflow on flake.nix has been fixed. Gitea action should pass	2024-04-09 17:06:26 +02:00
flake.nix	fix: use ENVIRONMENT instead of IS_TEST	2024-06-17 17:44:24 +02:00
LICENSE	Initial commit	2023-08-14 14:41:26 +00:00
poetry.lock	fix: path for graph tests	2024-05-24 11:42:07 +02:00
pyproject.toml	fix: path for graph tests	2024-05-24 11:42:07 +02:00
README.md	docs: fix typo	2024-02-20 13:14:56 +01:00

README.md

TEDective API

The TEDective API makes use of the OCDS data stored in KuzuDB and Meilisearch, and allows to make requests for certain entities such as organizations, awards, contracts or releases. It can give responses in JSON as well as in react-force-graph-ready format.

TEDective API

Background

The TEDective project aims to make European public procurement data from Tenders Electronic Daily (TED) explorable for non-experts. This repository contains all Python code used to build the API that on top of KuzuDB with (already converted to OCDSGraph) TED data.

Part of the TEDective Project

Install

This will be available on PyPi soon. Until then you can install it via Nix:

# Install flake into your profile
nix profile install git+https://git.fsfe.org/TEDective/api
app

Alternatively, you can clone this repository and build it via Nix yourself:

git clone https://git.fsfe.org/TEDective/api
cd api
nix-build
result/bin/app

Another way is to use poetry directly:

poetry install
poetry run app

Usage

🚧 TODO: (probably put the reference to documentation)

Maintainers

@linus @micgor32

Contributing

The easiest way to start developing is to use devenv via the provided flake.nix. So, clone this repository and run:

# If you have Nix installed
nix develop --impure
# This will drop you into a shell with all the dependencies installed
# If you want to bring up a meilisearch instance, simply run:
devenv up

Small note: If editing the README, please conform to the standard-readme specification. Also, please ensure that documentation is kept in sync with the code. Please note that the main documentation repository is added to this repository via git-subrepo. To update the documentation, please use the following commands:

git-subrepo pull docs
cd ./docs

# Make your changes
git commit -am "docs: update documentation for new feature"

# Preview your changes
pnpm install
pnpm run dev

# If you're happy with your changes, push them
git-subrepo push docs