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

Free Music Archive / Tribe Of Noise #1795

Open
6 tasks
obulat opened this issue Apr 21, 2021 · 0 comments
Open
6 tasks

Free Music Archive / Tribe Of Noise #1795

obulat opened this issue Apr 21, 2021 · 0 comments
Labels
πŸ’» aspect: code Concerns the software code in the repository 🌟 goal: addition Addition of new feature help wanted Open to participation from the community 🟩 priority: low Low priority and doesn't need to be rushed ☁️ provider: audio Audio provider 🧱 stack: catalog Related to the catalog and Airflow DAGs 🧹 status: ticket work required Needs more details before it can be worked on
Projects

Comments

@obulat
Copy link
Contributor

obulat commented Apr 21, 2021

This issue has been migrated from the CC Search Catalog repository

Author: annatuma
Date: Wed Mar 11 2020
Labels: providers,✨ goal: improvement,πŸ™… status: discontinued

The sites are:
https://freemusicarchive.org/static
https://www.tribeofnoise.com/

FMA is owned by Tribe of Noise.

We've reached out to inquire about whether or not there's an API we can use. If there isn't, integration may not be possible.

Provider API Endpoint / Documentation

Provider description

Licenses Provided

Provider API Technical info

Checklist to complete before beginning development

No development should be done on a Provider API Script until the following info is gathered:

  • Verify there is a way to retrieve the entire relevant portion of the provider's collection in a systematic way via their API.
  • Verify the API provides license info (license type and version; license URL provides both, and is preferred)
  • Verify the API provides stable direct links to individual works.
  • Verify the API provides a stable landing page URL to individual works.
  • Note other info the API provides, such as thumbnails, dimensions, attribution info (required if non-CC0 licenses will be kept), title, description, other meta data, tags, etc.
  • Attach example responses to API queries that have the relevant info.

General Recommendations for implementation

  • The script should be in the src/cc_catalog_airflow/dags/provider_api_scripts/ directory.
  • The script should have a test suite in the same directory.
  • The script must use the ImageStore class (Import this from
    src/cc_catalog_airflow/dags/provider_api_scripts/common/storage/image.py).
  • The script should use the DelayedRequester class (Import this from
    src/cc_catalog_airflow/dags/provider_api_scripts/common/requester.py).
  • The script must not use anything from
    src/cc_catalog_airflow/dags/provider_api_scripts/modules/etlMods.py, since
    that module is deprecated.
  • If the provider API has can be queried by 'upload date' or something similar,
    the script should take a --date parameter when run as a script, giving the
    date for which we should collect images. The form should be YYYY-MM-DD (so,
    the script can be run via python my_favorite_provider.py --date 2018-01-01).
  • The script must provide a main function that takes the same parameters as from
    the CLI. In our example from above, we'd then have a main function
    my_favorite_provider.main(date). The main should do the same thing calling
    from the CLI would do.
  • The script must conform to PEP8. Please use pycodestyle (available via
    pip install pycodestyle) to check for compliance.
  • The script should use small, testable functions.
  • The test suite for the script may break PEP8 rules regarding long lines where
    appropriate (e.g., long strings for testing).

Examples of other Provider API Scripts

For example Provider API Scripts and accompanying test suites, please see

  • src/cc_catalog_airflow/dags/provider_api_scripts/flickr.py and
  • src/cc_catalog_airflow/dags/provider_api_scripts/test_flickr.py, or
  • src/cc_catalog_airflow/dags/provider_api_scripts/wikimedia_commons.py and
  • src/cc_catalog_airflow/dags/provider_api_scripts/test_wikimedia_commons.py.
@obulat obulat mentioned this issue Jun 3, 2021
36 tasks
@zackkrida zackkrida added help wanted Open to participation from the community 🌟 goal: addition Addition of new feature labels Aug 12, 2021
@krysal krysal added 🧹 status: ticket work required Needs more details before it can be worked on πŸ’» aspect: code Concerns the software code in the repository 🟩 priority: low Low priority and doesn't need to be rushed labels Nov 18, 2022
@obulat obulat added the 🧱 stack: catalog Related to the catalog and Airflow DAGs label Feb 24, 2023
@obulat obulat transferred this issue from WordPress/openverse-catalog Apr 17, 2023
@obulat obulat changed the title [API Integration - AUDIO] Free Music Archive / Tribe Of Noise (original #315) [API Integration] Free Music Archive / Tribe Of Noise Jun 19, 2023
@obulat obulat changed the title [API Integration] Free Music Archive / Tribe Of Noise Free Music Archive / Tribe Of Noise Jun 20, 2023
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: addition Addition of new feature help wanted Open to participation from the community 🟩 priority: low Low priority and doesn't need to be rushed ☁️ provider: audio Audio provider 🧱 stack: catalog Related to the catalog and Airflow DAGs 🧹 status: ticket work required Needs more details before it can be worked on
Projects
Status: πŸ“‹ Backlog
Openverse
  
Backlog
Development

No branches or pull requests

4 participants