Materials-Consortia / Materials-Consortia/optimade-python-tools

Accept arbitrary collection classes in config

Open
#765 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

config enhancement server
Dominant language
Python
Stars
91
Forks
54
PR merge metrics
No merged PRs in 30d

Description

Continuing on the theme of #657, #740 and #739, it was discussed previously that we should allow more flexible and programmatic configuration.

For example, instead of the current approach of specifying a supported backend from the enum, then configuring the appropriate <backend>_uri variables, users of this library should be able to pass collection objects directly to the config (which themselves will have attached filter transformers and mappers) leaving the library code to just handle routing and response generation.

I believe this is something that @shyamd was interested in doing at some point in the future.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing configuration and backend-selection behavior, then read the related issues #657, #740, and #739 for prior discussion. The work is complete when configuration can accept collection objects directly, including their filter transformers and mappers, while the library handles routing and response generation.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api, backend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.