Add media properties generation

[obulat]

Fixes

Fixes #2186 by @obulat

Description

This PR adds the page with documentation on the media properties: a table with all of the audio and image properties with their database and Python characteristics.

The main part of this PR, though, is the script that parses the SQL definition files and the Python column definitions to create the media property tables, and the catalog/utilities/media_props_gen/media_props.md file that holds the more detailed descriptions of the media properties. This latter markdown file in this PR only contains the list of properties and the headings for descriptions. It will be filled in in the follow-up PR.

A new just catalog/generate-media-props script runs the parsers and markdown generators. If the generated markdown file is different from the file that was saved previously, a warning is issued to run the script again and commit the updated markdown file.

To parse the Python column definitions, this PR uses the ast module.

Testing Instructions

Change some property in the SQL file, the catalog/dags/common/storage/columns.py file or the catalog/utilities/media_props_gen/media_props.md file, and run just catalog/generate-media-props. The documentation/meta/media_properties.md file should reflect the changes, and a warning should appear in the console.

Also, review the media properties table and the full document from the comment below, and see if anything needs to be changed.

Checklist

• My pull request has a descriptive title (not a vague title likeUpdate index.md).
• My pull request targets the default branch of the repository (main) or a parent feature branch.
• My commit messages follow best practices.
• My code follows the established code style of the repository.
• I added or updated tests 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.
• I ran the DAG documentation generator (if applicable).

Developer Certificate of Origin

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.

[krysal]

@obulat, Would you be working on this PR in the following days? Or should it be closed?

[obulat]

@obulat, Would you be working on this PR in the following days? Or should it be closed?

Yes, @krysal , I'll be working on it

[AetherUnbound]

This is an excellent start!! I'm really excited to see us make progress on this and I'm loving the final output of the generation. I have a number of structure/code suggestions, as well as potential formatting improvements. I think we will also need tests for most of the utilities that are added here.

Additionally, the media properties themselves feel pretty squished together and difficult to delineate. I think adding a horizontal bar between each property can help visually differentiate the various properties, without affecting the table of contents in any way. Below is some code to accomplish that, and some screenshots of the difference:

diff --git a/catalog/utilities/media_props_gen/generate_media_properties.py b/catalog/utilities/media_props_gen/generate_media_properties.py
index 0505af318..106cb037d 100644
--- a/catalog/utilities/media_props_gen/generate_media_properties.py
+++ b/catalog/utilities/media_props_gen/generate_media_properties.py
@@ -98,7 +98,7 @@ def generate_long_form_doc(markdown_descriptions: dict, media_properties: dict)
         prop_doc = "".join(
             [f"{Md.heading(4, k)}{Md.line(v)}" for k, v in description.items()]
         )
-        media_docs += prop_heading + prop_doc
+        media_docs += prop_heading + prop_doc + Md.horizontal_line
 
     return media_docs
 
diff --git a/catalog/utilities/media_props_gen/md.py b/catalog/utilities/media_props_gen/md.py
index 8010fb011..2fb3a7a09 100644
--- a/catalog/utilities/media_props_gen/md.py
+++ b/catalog/utilities/media_props_gen/md.py
@@ -2,6 +2,9 @@ from pathlib import Path
 
 
 class Md:
+
+    horizontal_line = "\n---\n\n"
+
     @staticmethod
     def heading(level: int, text: str) -> str:
         """Add a heading to a markdown string."""

Before

After

[AetherUnbound]

Given that the workflow is almost exactly the same with only the files differing, I think we should create a _generate_markdown recipe with the more generic steps that then runs the shared logic for this and the above recipe.

[obulat]

I tried moving this workflow into docker, but then realized that we don't mount the local .sql files that we parse to generate the db docs into the container. Here's the error I got:

FileNotFoundError: [Errno 2] No such file or directory: '/opt/airflow/docker/upstream_db/0006_openledger_audio_schema.sql'

Is it possible to open them from the host, @AetherUnbound ? Seems like this would make the setup unnecessarily complex.

If I keep the code running locally as it is here now, then I won't be able to import media type constants. Even if I do manipulate the path somehow to make the constant importable, those files contain imports from airflow, which throw new errors.

[AetherUnbound]

ohhhh dang, I didn't even think about having to mount those files 😮 We can actually mount those files relatively easily in the recipe at least, it would just require modifying the just ../run command here:

openverse/catalog/justfile

Lines 127 to 129 in 78d799c

	just ../run \
	{{ SERVICE }} \
	"bash -c 'python catalog/utilities/dag_doc_gen/dag_doc_generation.py && chmod 666 /opt/airflow/catalog/utilities/dag_doc_gen/DAGs.md'"

Something similar to the way the tests are mounted (note the --volume here):

openverse/catalog/justfile

Lines 101 to 108 in 78d799c

	_mount-test command: up-deps
	env DC_USER="airflow" just ../run \
	--rm \
	-e AIRFLOW_VAR_INGESTION_LIMIT=1000000 \
	-w /opt/airflow/catalog \
	--volume {{ justfile_directory() }}/../docker:/opt/airflow/docker/ \
	{{ SERVICE }} \
	{{ command }}

Even though it's not needed for the DAG markdown generation, it can be done for all the generation recipes anyway!

[obulat]

Thank you, I'll try that.
Not related to this PR, but is the process of keeping those files up-to-date automated?

[AetherUnbound]

It is not! I believe that's the purview of #416 😄

[AetherUnbound]

Same note about constants here:

openverse/catalog/dags/common/constants.py

Line 11 in 002066f

MEDIA_TYPES = [AUDIO, IMAGE]

[github-actions]

Full-stack documentation: https://docs.openverse.org/_preview/3620

Please note that GitHub pages takes a little time to deploy newly pushed code, if the links above don't work or you see old versions, wait 5 minutes and try again.

You can check the GitHub pages deployment action list to see the current status of the deployments.

New files ➕:

• https://docs.openverse.org/_preview/3620/meta/media_properties/catalog.html

Changed files 🔄:

• https://docs.openverse.org/_preview/3620/catalog/guides/quickstart.html
• https://docs.openverse.org/_preview/3620/meta/ci_cd/jobs/catalog.html
• https://docs.openverse.org/_preview/3620/meta/media_properties/index.html