developmentseed/eoapi-cdk

Break out STAC Ingestor codebase into separate repo

Open

#4 opened on Nov 29, 2022

View on GitHub
 (5 comments) (1 reaction) (1 assignee)Python (6 forks)auto 404
enhancementhelp wanted

Repository metrics

Stars
 (29 stars)
PR merge metrics
 (PR metrics pending)

Description

Currently, we store the STAC Ingestor codebase alongside the STAC Ingestor CDK construct. This means that if a user wants to customize the STAC Ingestor, they need to copy/replicate the STAC Ingestor codebase into a separate repo, customize it, and then recreate the logic around the StacIngestor construct. A better scenario would be to be able to provide the construct an argument that represents a pip-friendly location the codebase can be installed from. I am not certain of the best way to do this.

First pass at a solution

Currently, we are using the PythonFunction construct which requires that a user pass in a directory where either a Pipfile.lock, poetry.lock, or requirements.txt file can be found (source).

It seems like something along the lines of the following may work: Create a custom construct that took in the identifier of an installable module, wrote that to a requirements.txt file, and then passed the path of that requirements.txt file to the Python Lambda to be built. I'm not sure how we could support the customization of the entry and handler arguments...

Contributor guide

Research direction
Investigate how to separate the STAC Ingestor codebase into a standalone pip installable package and modify the CDK construct to accept a reference to such a package instead of a local directory. Look into the PythonFunction construct's entry point and handler customization options.
Tech stack
pythonaws
Domain
cloudinfrastructure
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
PythonAWS CDKGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40