search

catalyst-cooperative / pudl-archiver

A tool for capuring snapshots of public data sources and archiving them on Zenodo for programmatic use.
MIT License
4 stars 1 forks source link

Include expected filename in `rssfeed` metadata #178

Open jdangerx opened 11 months ago

jdangerx commented 11 months ago

In src/pudl_archiver/archivers/ferc/xbrl.py, we have some logic that generates an informative filename from a filing's metadata. If we want to use that filename elsewhere, we need to reconstruct the filename logic.

We should include the filing name in the metadata, so that is less brittle.

## Scope
* [ ] metadata in `rss_feed` includes a `filename` field
* [ ] `filename` field is used in `ferc-xbrl-extractor`: `src/ferc_xbrl_extractor/instance.py:get_filing_name` instead of re-capitulating the logic
hfireborn commented 5 months ago

@catalyst-cooperative/com-dev Is this still open? I'd like to work on this if it would be a good task for a first time contributor

jdangerx commented 5 months ago

It sure is, do you have any questions about it? Separately, if you're coming to office hours today we could talk about it then.