feat: GSoC 2026 scaffold - connector package, design docs, benchmark, and config layer#2
Open
Vishmayraj wants to merge 27 commits into
Open
feat: GSoC 2026 scaffold - connector package, design docs, benchmark, and config layer#2Vishmayraj wants to merge 27 commits into
Vishmayraj wants to merge 27 commits into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR establishes the complete project scaffold for the istSOS Metadata Connector (GSoC 2026, Idea 1). It clears the 2024 GSoC working files that were in the upstream branch and replaces them with the week 1-3 deliverables for this project: the connector package skeleton, three design reference documents, the configuration layer, a benchmark script with verified results, and a temporary API to validate STAC output against a live browser.
This is a scaffold PR. The connector module files (
harvester.py,cache.py,stac_transformer.py,dcat_transformer.py) are present as stubs with docstrings and public interface signatures. Implementations follow in subsequent PRs per the staging plan.What this PR includes
Cleared from upstream
Connector package scaffold (
connector/)config.py- pydantic-settings configuration layer, fully implemented. Single source of truth for all connector settings.get_settings()singleton vialru_cache. Field-level validation including trailing slash stripping onSTA_BASE_URLandhas_mandatory_dcat_fieldsproperty for startup warnings.harvester.py- stub withHarvestedCatalog,HarvestedThingdataclasses and public interface signatures. Full design spec indocs/Harvesting-Layer-Reference.md.stac_transformer.py- stub with public interface signatures.dcat_transformer.py- stub with public interface signatures.cache.py- stub with public interface signatures.exceptions.py-HarvesterErrorhierarchy fully defined.utils.py- stub.__init__.py- package init.Design reference documentation (
docs/)Harvesting-Layer-Reference.md- complete design specification forharvester.pyandcache.py. Covers the STA query strategy, internal data model with all nested dict shapes, the 12-point transformer contract that downstream transformers can rely on, and the public interface. Written before implementation to lock down the contract first.STA-STAC-Transformation-Layer-Reference.md- field-by-field STA to STAC 1.0 mapping specification. Covers Thing to Collection, Datastream to Item, spatial fallback chain, temporal fallback chain, bbox derivation, collection extent computation, asset construction, and all link relations.STA-DCAT-AP-Transformation-Layer-Reference.md- field-by-field STA to DCAT-AP 3.0 mapping specification. Covers Datastream todcat:Dataset, Thing todcat:DatasetSeries, catalog-level mandatory field gap strategy, Distribution construction for JSON/CSV/MQTT access points, JSON-LD and Turtle serialization, and theDatastream.propertieskey convention for operator-supplied DCAT fields.Benchmark script and results (
benchmark_stac.py)Temporary validation API (
api.py)Project files
README.md- updated to reflect the current project structure and architecture.requirements.txtandrequirements-test.txt- dependency manifests..env.example- annotated environment variable template..gitignore- excludes.env, benchmark outputs, and cache files.Architecture note
The connector was originally scoped as a standalone microservice harvesting via STA HTTP pagination. Benchmark results showed that at production scale (22,941 Datastreams) this approach requires 57 sequential HTTP round trips taking 42 seconds. A revised architecture using direct asyncpg queries against the istSOS4 Postgres database and Redis with LISTEN/NOTIFY cache invalidation is being proposed to mentors this week. Pending their confirmation, week 4 implementation will follow the integrated approach. The design docs in this PR already reflect the proposed integrated design in the harvesting layer reference.
Related
benchmark.log