Add Smithsonian process and report script by oree-xx · Pull Request #278 · creativecommons/quantifying

oree-xx · 2026-01-29T09:39:48Z

Fixes

Description

Added stacked bar plot in plotly.py
Completing the process and report stage for Smithsonian
Added analysis of units by top 10 and lowest 10

Checklist

I have read and understood the Developer Certificate of Origin (DCO), below, which covers the contents of this pull request (PR).
My pull request doesn't include code or content generated with AI (also see Avoiding generative AI development tools — Creative Commons Open Source).
My pull request has a descriptive title (not a vague title like Update index.md).
My pull request targets the default branch of the repository (main or master).
My commit messages follow best practices.
My code follows the established code style of the repository.
I added or updated unit tests and/or test scripts for the changes I made (if applicable).
I added or updated documentation (if applicable).
I tried running the project locally and verified that there are no
visible errors.

Developer Certificate of Origin

For the purposes of this DCO, "license" is equivalent to "license or public domain dedication," and "open source license" is equivalent to "open content license or public domain dedication."

Developer Certificate of Origin

Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

scripts/plot.py

TimidRobot

Good to see this coming together! Acknowledging this is a WIP, you'll need to update labels and descriptions to provide context and make the data more meaningful.

It might also be worth looking to see if there's any way to automatically get the full names for units. I have no idea what the abbreviations mean.

scripts/3-report/smithsonian_report.py

TimidRobot

This is coming along nicely, keep up the good work!

TimidRobot · 2026-02-09T15:26:17Z

scripts/1-fetch/smithsonian_fetch.py

 ]
 QUARTER = os.path.basename(PATHS["data_quarter"])

+unit_map = {


Please add a comment indicating how this data was compiled. Something like "Manually compiled from information on URL".

Also, does the source(s) have information on:

2026-02-09 16:31:34,002 - WARNING - smithsonian_fetch - New unit code(s) not in unit_map: ['ACAH', 'CHSDM', 'EEPA', 'FSA', 'NAA', 'NASMAC', 'NMAIA', 'NPMA', 'SAAMPAIK', 'SI']

TimidRobot · 2026-02-09T15:34:08Z

scripts/1-fetch/smithsonian_fetch.py

    "TOTAL_OBJECTS",
 ]
 HEADER_2_UNITS = [
    "UNIT",


Better to store both unit code and unit names since the unit names are not available from the API.

TimidRobot · 2026-02-09T15:36:36Z

scripts/3-report/smithsonian_report.py

+        "Overview",
+        None,
+        None,
+        "The Smithsonian data returns the overall "


Please remove space at end of string

TimidRobot · 2026-02-09T15:37:42Z

scripts/3-report/smithsonian_report.py

+        f"The results indicate a total record of {total_objects} objects,"
+        f" with a breakdown of {CC0_records} objects without CC0 Media and"
+        f" {CC0_records_with_media} objects with CC0 Media, taking a"


Please format numbers with commas to improve readability.

TimidRobot · 2026-02-09T15:39:01Z

scripts/3-report/smithsonian_report.py

+        " representing museums, libraries, zoos and many other"
+        f" with a minimum of {min_unit} objects.",


min_units seems to be misleading. Shouldn't it be something like min_objects?

How does a "a minimum of 147 objects" relate to the 3rd plot that shows Anacostia Community Museum Archives with 57 works?

Please update wording: ~~and many other~~ ➡️ and other institutions

TimidRobot · 2026-02-09T15:44:15Z

scripts/3-report/smithsonian_report.py

+        "Plots showing totals by units.",
+        "This shows the distribution of top 10"
+        " units/ sub providers across smithsonian"
+        f" with an average of {average_unit} objects"
+        " across the top 10 sub providers.",


Please hard wrap at 79 instead of 53

Please define "NMNH"

Please format number with commas to improve readability

TimidRobot · 2026-02-09T15:47:28Z

scripts/3-report/smithsonian_report.py

First use of "Smithsonian" in report should be "Smithsonian Institute"

I think the information presented to the user should replace "units" and "sub providers" with "institute members"

TimidRobot · 2026-02-09T15:53:59Z

scripts/plot.py

The institution member (units) plots are dominated by the member names:

I propose a function be added to this shared library that will insert a newline roughly halfway through the name (replacing a space).

Alternatively, the abbreviations could be used and the definitions of those abbreviations could be added as text below the plot.

I'm open to other ideas, as well.

TimidRobot · 2026-02-09T16:01:13Z

scripts/3-report/smithsonian_report.py

+    )
+
+
+def plot_totals_by_records(args):


The new plot is interesting!

Please:

populate "bar x scale" value (I expect it should be linear instead of None)

see note about label/name length

indicate why the 10 records are shown (ex. 10 with hightest cc0 media percentage)

key shouldn't obscure data

smithsonian and stacked bar plot

5fc6503

oree-xx requested review from a team as code owners January 29, 2026 09:39

oree-xx requested review from TimidRobot and possumbilities and removed request for a team January 29, 2026 09:39

Made script executable

0e6f842

cc-open-source-bot added this to TimidRobot Jan 29, 2026

cc-open-source-bot moved this to In review in TimidRobot Jan 29, 2026

TimidRobot requested changes Jan 29, 2026

View reviewed changes

scripts/plot.py Show resolved Hide resolved

scripts/plot.py Outdated Show resolved Hide resolved

Made review changes

5776eef

TimidRobot requested changes Jan 29, 2026

View reviewed changes

scripts/3-report/smithsonian_report.py Show resolved Hide resolved

oree-xx added 3 commits February 6, 2026 11:34

Added unit full name and updates

4153081

Made changes to the variable names

646cb24

Made changes to the graphs

7ceb648

oree-xx changed the title ~~[WIP] Smithsonian and stacked bar plot~~ Add Smithsonian process and report script Feb 6, 2026

oree-xx added 2 commits February 6, 2026 13:49

Merge remote-tracking branch 'origin/main' into process_report

9e73061

Apply Black formatting to smithsonian scripts

15720d1

oree-xx force-pushed the process_report branch from cb5294c to 15720d1 Compare February 6, 2026 18:55

TimidRobot self-assigned this Feb 9, 2026

TimidRobot requested changes Feb 9, 2026

View reviewed changes

		" representing museums, libraries, zoos and many other"
		f" with a minimum of {min_unit} objects.",

		)


		def plot_totals_by_records(args):

Uh oh!

Conversation

oree-xx commented Jan 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Fixes

Description

Checklist

Developer Certificate of Origin

Uh oh!

Uh oh!

Uh oh!

TimidRobot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

TimidRobot left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

oree-xx commented Jan 29, 2026 •

edited

Loading