Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provider sources model #9

Closed
2 tasks
darribas opened this issue May 21, 2021 · 0 comments · Fixed by #23
Closed
2 tasks

Provider sources model #9

darribas opened this issue May 21, 2021 · 0 comments · Fixed by #23
Labels
enhancement New feature or request

Comments

@darribas
Copy link
Contributor

This issue describes the model for managing sources.

Currently, we envision at least two sources of providers:

  • Automatically scraped from Leaflet providers: these is parsed with parse_leaflet_providers.py and stored under provider_sources/leaflet-providers-parsed.json
  • Community contributed additional providers: these are sources provided independently from the official Leaflet list by the community (following guidelines detailed in the docs). They get contributed to provider_sources/community_providers.json, which is a file that should be stored in prettified JSON format. Community contributions come as PRs against that file.

In terms of what gets shipped with the package that can be installed, one idea is to write all the sources into a single, compressed JSON file that ships with the package and loads on import. That way, neither the scraped Leaflet, nor the community, pretty JSON files would be shipped, just the merged and compressed one.

To implement this, we will need:

  • Tooling to take all JSON files in provider_sources and merge/compress into a single provider_sources.json
  • Load providers on import only from provider_sources.json
@darribas darribas added the enhancement New feature or request label May 21, 2021
This was referenced May 23, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant