Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refine openverse-attribution as a standalone pacakge #4182

Open
dhruvkb opened this issue Apr 23, 2024 · 0 comments
Open

Refine openverse-attribution as a standalone pacakge #4182

dhruvkb opened this issue Apr 23, 2024 · 0 comments
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

Comments

@dhruvkb
Copy link
Member

dhruvkb commented Apr 23, 2024

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.

  1. Devise a naming system. Will it be called openverse-attribution or something more generally suitable like cc-attribution (comment)?
  2. Will the 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 shell README.md that only points to the docs (comment)?

There are also some code refactors.

  1. Use License enum as the argument type for param license(_slug?) in get_attribution_text (comment).
  2. Make 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.

@dhruvkb dhruvkb added 🟩 priority: low Low priority and doesn't need to be rushed ✨ goal: improvement Improvement to an existing user-facing feature 💻 aspect: code Concerns the software code in the repository 🐍 tech: python Involves Python 🧱 stack: api Related to the Django API labels Apr 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Projects
Status: 📋 Backlog
Development

No branches or pull requests

1 participant