quantifying

Quantifying the Commons

Overview

This project seeks to quantify the size and diversity of the commons--the collection of works that are openly licensed or in the public domain.

Code of Conduct

CODE_OF_CONDUCT.md:

The Creative Commons team is committed to fostering a welcoming community. This project and all other Creative Commons open source projects are governed by our Code of Conduct. Please report unacceptable behavior to [email protected] per our reporting guidelines.

Contributing

See CONTRIBUTING.md.

Development

Prerequisites

This repository uses pipenv to manage the required Python modules:

• Linux: Installing Pipenv
• macOS:
  1. Install Homebrew
  2. Install pipenv:

     brew install pipenv
     

  3. Create the Python virtual environment and install prerequisites using: pipenv:

     shell pipenv sync --dev
     

  4. Then you can run the static analysis tools:

     shell ./tools.sh
     

Running Scripts that Require Client Credentials

To successfully run scripts that require client credentials, you will need to follow these steps:

1. Copy the contents of the env.example file in the script's directory to .env:

   cp env.example .env
   

2. Uncomment the variables in the .env file and assign values as needed. See sources.md on how to get credentials:

   GOOGLE_API_KEYS=your_api_key
   PSE_KEY=your_pse_key
   

3. Save the changes to the .env file.

4. You should now be able to run scripts that require client credentials without any issues.

Tooling

• Python Guidelines — Creative Commons Open Source
• Black: the uncompromising Python code formatter
• flake8: a python tool that glues together pep8, pyflakes, mccabe, and third-party plugins to check the style and quality of some python code.
• isort: A Python utility / library to sort imports
  • It doesn't import any libraries, it only sorts and formats them.

Data Sources

Kindly visit the sources.md file for it.

History

For information on past efforts, see history.md.

Copying & License

Code

LICENSE: the code within this repository is licensed under the Expat/MIT license.

Data

The data within this repository is dedicated to the public domain under the CC0 1.0 Universal (CC0 1.0) Public Domain Dedication.

Documentation

The documentation within the project is licensed under a Creative Commons Attribution 4.0 International License.