proj-forge / proj-forge/proj-forge.github.io
:zap: Speed
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
[!IMPORTANT]
This task is just for fun and should not be treated as a priority!
Rendering the full dataset is taking a bit over a minute now since we've added some more fields. Functionally, this shouldn't matter. If our website updates a couple minutes behind the newest Proj release, we're doing really good. This change will also be good for reducing environmental impact, though!
We could look in to rewriting our little static site generator in Rust using Rust Proj bindings (https://github.com/georust/proj) and a templating engine (https://crates.io/categories/template-engine). I figure we'll be limited by i/o. The Proj DB is only 8MB, and our output is <200MB, so I suspect we can reduce runtime from >1 minute to sub-second on SATA/NVMe. I suspect GHA has slower storage than this, but still :)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Begin by locating the existing Python static site generator and measuring its full-dataset runtime and I/O; the issue names no files or tests. Evaluate a Rust rewrite using Rust Proj bindings and a templating engine. Done means the generator produces equivalent output with a substantially shorter runtime and no functional regression.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python, rust
- Domain
- performance, tooling
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100