creativecommons / quantifying

quantify the size and diversity of the commons--the collection of works that are openly licensed or in the public domain
MIT License
22 stars 30 forks source link

fixes the issue #37 Documentation of Data Sources and APIs used in the project #38

Closed samadpls closed 1 year ago

samadpls commented 1 year ago

Fixes

Fixes #37 by @samadpls

Description

This task involves creating a markdown file named "source.md" that provides information about the various data sources and APIs used in the project. This file will be linked to from the README file to direct users to the sources information. The aim is to make it easier for users to understand where the data is coming from and how it is being accessed.

The "source.md" file contains detailed information on each data source and API used, including a description, API documentation links, API information, whether an API key is required, and what the API query limits are. The file also provides links to relevant resources and sample data.

The document includes information on several data sources and APIs used in the project, such as the Creative Commons Legal Tools, Flickr API, Google Custom Search JSON API, Internet Archive Python Interface, Metropolitan Museum of Art Collection API, Vimeo API, MediaWiki API and YouTube API. For each source, the document provides relevant information on the data and how it is accessed, as well as links to documentation and sample data.

Checklist

- [x] My pull request has a descriptive title (not a vague title like `Update index.md`). - [x] My pull request targets the *default* branch of the repository (`main` or `master`). - [x] My commit messages follow [best practices][best_practices]. - [x] My code follows the established code style of the repository. - [ ] I added or updated tests for the changes I made (if applicable). - [x] I added or updated documentation (if applicable). - [x] I tried running the project locally and verified that there are no visible errors. [best_practices]:https://gist.github.com/robertpainsi/b632364184e70900af4ab688decf6f53 ## 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. ```