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

Reconsider ResourceMapper and Quantity design

Open
#809 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

priority/medium suggestions
Dominant language
Python
Stars
91
Forks
54
PR merge metrics
No merged PRs in 30d

Description

Following on from discussions with @markus1978 and @CasperWA in #797, we should consider refactoring much of the functionality provided by the Quantity class into the base entry resource mapper.

We could also think about using some of the nomenclature we have from the mappers already?

Originally posted by @CasperWA in https://github.com/Materials-Consortia/optimade-python-tools/pull/797#r636050872

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 reading the Quantity class and the base entry resource mapper, then review the discussion in issue #797 and its linked pull request. The work is not yet concrete: it needs an agreed design for moving functionality and choosing mapper nomenclature before implementation can begin.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api, backend-api-design
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.