Refine openverse-attribution
as a standalone pacakge
#4182
Labels
💻 aspect: code
Concerns the software code in the repository
✨ goal: improvement
Improvement to an existing user-facing feature
🟩 priority: low
Low priority and doesn't need to be rushed
🧱 stack: api
Related to the Django API
🐍 tech: python
Involves Python
Problem
We can consider
openverse-attribution
to be its own standalone library, our first Python library that can be published to PyPI from the monorepo. There are a number of things that need to be done before that is feasible.Description
There are some higher-level discussions.
openverse-attribution
or something more generally suitable likecc-attribution
(comment)?README.md
file be descriptive and duplicated between the docs site and the library? Will it be copied into the package during build? Will it be a shellREADME.md
that only points to the docs (comment)?There are also some code refactors.
License
enum as the argument type for paramlicense(_slug?)
inget_attribution_text
(comment).attribution_template
a module level constant_ATTRIBUTION_TEMPLATE
(comment).Additional context
Currently the package is local and only used by the API. Some of these concerns will get real once we're set on publishing the package to PyPI.
The text was updated successfully, but these errors were encountered: