pepkit / pepkit/pepdbagent

Order of processing of PEP

Open
#10 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

brainstorming
Dominant language
Python
Stars
2
Forks
1
PR merge metrics
No merged PRs in 30d

Description

When a PEP is put in the database, when is it processed? I can see two possibilities:

  1. A PEP is loaded, processed, and the processed PEP is put into the database.
  2. A PEP is loaded but not processed, the unprocessed PEP is put into the database.

The advantage of 1 is that the processing only happens once, so it reduces compute time. With 2, you'd have to reprocess it every time the PEP is requested.

However, if we want to allow the user to tweak the rendering of the PEP, for example, by changing env vars (https://github.com/pepkit/pephub/issues/3), this will only be possible with option 2.

Hybrid?

Is it possible to split the idea of "processing" into two stages: 1. the sample_modifiers and project_modifiers are done before entry into the database, and then 2. path expansion is done on-the-fly ?

Contributor guide

No contributing guide indexed for this repository

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 tracing how PEPs are loaded, processed, and stored in the database. Compare processing before storage with processing on request, including the proposed hybrid of modifiers and path expansion. Done should be an agreed processing design that accounts for rendering changes through environment variables.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
database
Issue type
Feature
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.