renamed openverse-api directory to openverse_api

.github/dependabot.yml

@@ -8,8 +8,8 @@ version: 2
 updates:
   # Enable version updates for Docker containers in Openverse API
   - package-ecosystem: 'docker'
-    # Look for a `Dockerfile` in the `/openverse-api` directory
-    directory: '/openverse-api'
+    # Look for a `Dockerfile` in the `/openverse_api` directory
+    directory: '/openverse_api'
     # Check for updates once a week
     schedule:
       interval: 'weekly'
@@ -20,8 +20,8 @@ updates:
 
   # Enable version updates for Python libs in Openverse API
   - package-ecosystem: 'pip'
-    # Look for a `Pipfile` in the `/openverse-api` directory
-    directory: '/openverse-api'
+    # Look for a `Pipfile` in the `/openverse_api` directory
+    directory: '/openverse_api'
     # Check for updates once a week
     schedule:
       interval: 'weekly'

.github/release-drafter.yml

@@ -32,4 +32,4 @@ template: |
 
   ## See an issue?
 
-  Does anything look wrong in this release? Please [report a bug](https://github.com/WordPress/openverse-api/issues/new?labels=bug%2C+awaiting+triage&template=bug_report.md).
+  Does anything look wrong in this release? Please [report a bug](https://github.com/WordPress/openverse_api/issues/new?labels=bug%2C+awaiting+triage&template=bug_report.md).

.github/workflows/integration-tests.yml

@@ -18,7 +18,7 @@ jobs:
       with:
         python-version: 3.9
     - name: Lint
-      working-directory: ./openverse-api
+      working-directory: ./openverse_api
       run: |
         pip install --upgrade pipenv
         pipenv install --dev
@@ -34,7 +34,7 @@ jobs:
       run: |
         pip install pytest pipenv
         sudo apt-get install libexempi8 librdkafka-dev
-        PIPENV_PIPFILE=./openverse-api/Pipfile pipenv install --system --deploy --dev &
+        PIPENV_PIPFILE=./openverse_api/Pipfile pipenv install --system --deploy --dev &
     - name: Pull containers
       run: docker-compose pull --ignore-pull-failures
     - name: Cache Docker images
@@ -49,6 +49,6 @@ jobs:
     - name: Wait for data to be indexed in Elasticsearch
       run: bash -c 'while [[ "$(curl -sb -H "Accept:application/json" http://localhost:9200/_cat/aliases/image | grep -c image-)" == "0" || "$(curl -sb -H "Accept:application/json" http://localhost:9200/_cat/aliases/audio | grep -c audio-)" == "0" ]]; do sleep 5 && docker-compose logs; done'
     - name: Run API tests
-      run: cd openverse-api && test/run_test.sh
+      run: cd openverse_api && test/run_test.sh
     - name: Run analytics tests
-      run: cd ./analytics && docker exec -i openverse-api_analytics_1 /bin/bash -c 'PYTHONPATH=. pipenv run pytest tests.py'
+      run: cd ./analytics && docker exec -i openverse_api_analytics_1 /bin/bash -c 'PYTHONPATH=. pipenv run pytest tests.py'

CONTRIBUTING.md

@@ -12,19 +12,19 @@ Please consult the [README](./README.md) and [CODEBASE](./CODEBASE.md) files at
 
 ### Bugs
 
-If you find a bug, please open an issue in this repository describing the bug. You can file a bug [here](https://github.com/wordpress/openverse-api/issues/new?template=bug_report.md). You will see a bug report template with the required information you should provide.
+If you find a bug, please open an issue in this repository describing the bug. You can file a bug [here](https://github.com/wordpress/openverse_api/issues/new?template=bug_report.md). You will see a bug report template with the required information you should provide.
 
 After that, don't forget to tag the issue with the "Bug" label.
 
 ### Proposing changes or new features
 
-If you have an idea of a new feature or change to how the Openverse API works, please [start a discussion](https://github.com/WordPress/openverse-api/discussions/new?category=ideas) so we can discuss the possibility of that change or new feature being implemented and released in the future. This lets us come to an agreement about the proposed idea before any work is done.
+If you have an idea of a new feature or change to how the Openverse API works, please [start a discussion](https://github.com/WordPress/openverse_api/discussions/new?category=ideas) so we can discuss the possibility of that change or new feature being implemented and released in the future. This lets us come to an agreement about the proposed idea before any work is done.
 
 ### Pull requests
 
 Before you start writing code, make sure there is an issue open. Pull requests without a link to an existing issue won't be merged.
 
-If you want to get started contributing code to this project but don't know exactly what to work on, we compiled a good list of issues labeled as [`good first issue`](https://github.com/wordpress/openverse-api/labels/good%20first%20issue) which are small in scope and not so complex to solve. There are also issues labeled as [`help wanted`](https://github.com/wordpress/openverse-api/labels/help%20wanted) which can be a bit more complex but are good examples of things we are currently accepting help from the community.
+If you want to get started contributing code to this project but don't know exactly what to work on, we compiled a good list of issues labeled as [`good first issue`](https://github.com/wordpress/openverse_api/labels/good%20first%20issue) which are small in scope and not so complex to solve. There are also issues labeled as [`help wanted`](https://github.com/wordpress/openverse_api/labels/help%20wanted) which can be a bit more complex but are good examples of things we are currently accepting help from the community.
 
 Any code modifications will have to be accompanied by the appropriate unit tests. This will be checked and verified during code review. Once the Pull Request is opened, our CI server will run the unit test suite and run a code linter to verify that the code follows the coding guidelines.
 
@@ -34,10 +34,10 @@ Any code modifications will have to be accompanied by the appropriate unit tests
 
 You can check the health of a live deployment of the API by running the live integration tests.
 
-1. Change directory to `openverse-api`
+1. Change directory to `openverse_api`
 
 ```
-cd openverse-api
+cd openverse_api
 ```
 
 1. Install all dependencies for Openverse API
@@ -88,4 +88,4 @@ python3 test/integration_tests.py
 
 ## Questions or Thoughts?
 
-Feel free to [join us on Slack](https://make.wordpress.org/chat/) and discuss the project with the engineers and community memebers on #openverse. We also use [GitHub discussions](https://github.com/WordPress/openverse-api/discussions) for feature requests, troubleshooting, and other 'off-topic' conversations.
+Feel free to [join us on Slack](https://make.wordpress.org/chat/) and discuss the project with the engineers and community memebers on #openverse. We also use [GitHub discussions](https://github.com/WordPress/openverse_api/discussions) for feature requests, troubleshooting, and other 'off-topic' conversations.

CONTRIBUTORS.md

@@ -1,4 +1,4 @@
-# openverse-api contributors (sorted alphabetically by last name)
+# openverse_api contributors (sorted alphabetically by last name)
 
 - **[Liza Daley](https://github.com/lizadaly)**
   - Built CC Search prototype, bits of which live on in this repository to this day

DOCUMENTATION_GUIDELINES.md

@@ -12,9 +12,9 @@ Openverse API uses [drf-yasg](https://github.com/axnsan12/drf-yasg), which is a
 
 ## How to Start Contributing
 
-- Run the server locally by following this [link](https://github.com/wordpress/openverse-api#running-the-server-locally)
+- Run the server locally by following this [link](https://github.com/wordpress/openverse_api#running-the-server-locally)
 - Update documentation
-- Make sure the updates passed the automated tests in this [file](https://github.com/wordpress/openverse-api/blob/master/.github/workflows/integration-tests.yml)
+- Make sure the updates passed the automated tests in this [file](https://github.com/wordpress/openverse_api/blob/master/.github/workflows/integration-tests.yml)
 - Commit and push
 - Create pull request by following [GitHub Repo Guidelines](https://opensource.creativecommons.org/contributing-code/github-repo-guidelines/)
 

README.md

@@ -2,7 +2,7 @@
 
 ## Purpose
 
-The Openverse API (`openverse-api`) is a system that allows programmatic access to public domain digital media. It is our ambition to index and catalog [billions of openly-licensed works](https://stateof.creativecommons.org/), including articles, songs, videos, photographs, paintings, and more. Using this API, developers will be able to access the digital commons in their own applications.
+The Openverse API (`openverse_api`) is a system that allows programmatic access to public domain digital media. It is our ambition to index and catalog [billions of openly-licensed works](https://stateof.creativecommons.org/), including articles, songs, videos, photographs, paintings, and more. Using this API, developers will be able to access the digital commons in their own applications.
 
 This repository is primarily concerned with back end infrastructure like datastores, servers, and APIs. The pipeline that feeds data into this system can be found in the [Openverse Catalog repository](https://github.com/WordPress/openverse-catalog). A front end web application that interfaces with the API can be found at the [Openverse frontend repository](https://github.com/WordPress/openverse-frontend).
 
@@ -23,10 +23,10 @@ You need to install [Docker](https://docs.docker.com/install/) (with [Docker Com
 3. Clone Openverse API
 
 ```
-git clone https://github.com/WordPress/openverse-api.git
+git clone https://github.com/WordPress/openverse_api.git
 ```
 
-4. Change directories with `cd openverse-api`
+4. Change directories with `cd openverse_api`
 5. Start Openverse API locally by running the docker containers. You can use usual `docker-compose` commands or the simplified `just` command. You will need the [just](https://github.com/casey/just#installation) command runner installed to follow the next steps.
 
 ```
@@ -38,7 +38,7 @@ just up
 7. Open up your browser and type `localhost:8000` in the search tab
 8. Make sure you see the local API documentation
    ![Local API Documentation](local_api_documentation.PNG)
-9. Open a new CMD or terminal and change directory to `openverse-api`
+9. Open a new CMD or terminal and change directory to `openverse_api`
 10. Still in the new CMD or terminal, load the sample data. This script requires a local postgres installation to connect to and alter our database.
 
 ```
@@ -106,7 +106,7 @@ Every week, the latest version of the data is automatically bulk copied ("ingest
 
 ### Description of subprojects
 
-- _openverse-api_ is a Django Rest Framework API server. For a full description of its capabilities, please see the [browsable documentation](https://api.openverse.engineering).
+- _openverse_api_ is a Django Rest Framework API server. For a full description of its capabilities, please see the [browsable documentation](https://api.openverse.engineering).
 - _ingestion-server_ is a service for downloading and indexing search data once it has been prepared by the Openverse Catalog
 - _analytics_ is a Falcon REST API for collecting usage data.
 
@@ -172,7 +172,7 @@ You can view the custom administration views at the `/admin/` endpoint.
 
 Pull requests are welcome! Feel free to [join us on Slack](https://make.wordpress.org/chat/) and discuss the project with the engineers and community members on #openverse.
 
-You are welcome to take any open issue in the tracker labeled [`help wanted`](https://github.com/WordPress/openverse-api/labels/help%20wanted) or [`good first issue`](https://github.com/WordPress/openverse-api/labels/good%20first%20issue); **there's no need to ask for permission in advance**. Other issues are open for contribution as well, but may be less accessible or well-defined in comparison to those that are explicitly labeled.
+You are welcome to take any open issue in the tracker labeled [`help wanted`](https://github.com/WordPress/openverse_api/labels/help%20wanted) or [`good first issue`](https://github.com/WordPress/openverse_api/labels/good%20first%20issue); **there's no need to ask for permission in advance**. Other issues are open for contribution as well, but may be less accessible or well-defined in comparison to those that are explicitly labeled.
 
 See the [CONTRIBUTING](CONTRIBUTING.md) file for details.
 

analytics/docs/swagger.yaml

@@ -8,7 +8,7 @@ info:
     email: "[email protected]"
   license:
     name: "MIT License"
-    url: "https://github.com/wordpress/openverse-api/blob/master/LICENSE"
+    url: "https://github.com/wordpress/openverse_api/blob/master/LICENSE"
 host: "api.openverse.engineering"
 basePath: "/analytics"
 tags:

docker-compose.yml

@@ -52,11 +52,11 @@ services:
         hard: 65536
 
   web:
-    build: openverse-api/
+    build: openverse_api/
     image: openverse_api
     command: python manage.py runserver 0.0.0.0:8000
     volumes:
-      - ./openverse-api:/openverse-api
+      - ./openverse_api:/openverse_api
     ports:
       - "8000:8000"
       - "4444:4444"

ingestion_server/README.md

@@ -14,7 +14,7 @@ Performance is dependent on the size of the target Elasticsearch cluster, databa
 
 ## How Indexing Works
 
-![How indexing works](https://github.com/wordpress/openverse-api/blob/master/ingestion_server/howitworks.png)
+![How indexing works](https://github.com/wordpress/openverse_api/blob/master/ingestion_server/howitworks.png)
 
 ## Safety and security considerations
 

ingestion_server/ingestion_server/categorize.py

@@ -2,7 +2,7 @@
 
 
 """
-https://github.com/wordpress/openverse-api/issues/340
+https://github.com/wordpress/openverse_api/issues/340
 
 Attempt to figure out the image type (illustration, vector, photograph, or
 digitized artwork) based on its source and file extension.

ingestion_server/ingestion_server/constants/media_types.py

@@ -1,5 +1,5 @@
 """
-Also see `openverse-api/constants/media_types.py`
+Also see `openverse_api/constants/media_types.py`
 """
 
 AUDIO_TYPE = "audio"

ingestion_server/ingestion_server/elasticsearch_models.py

@@ -215,7 +215,7 @@ class Image(Media):
     class AspectRatios(Enum):
         """
         These aspect ratios are also hardcoded in the `aspect_ratio` field in
-        openverse-api/catalog/api/serializers/image_serializers.py.
+        openverse_api/catalog/api/serializers/image_serializers.py.
         """
 
         TALL = auto()
@@ -227,7 +227,7 @@ class ImageSizes(Enum):
         Maximum threshold for each image size band
 
         These sizes are also hardcoded in the `aspect_ratio` field in
-        openverse-api/catalog/api/serializers/image_serializers.py.
+        openverse_api/catalog/api/serializers/image_serializers.py.
         """
 
         SMALL = 640 * 480
@@ -299,7 +299,7 @@ class Durations(Enum):
         Maximum threshold for each audio duration band
 
         These durations are also hardcoded in the `duration` field in
-        openverse-api/catalog/api/serializers/audio_serializers.py.
+        openverse_api/catalog/api/serializers/audio_serializers.py.
         """
 
         SHORT = 4 * 60 * 1e3  # under 4 minutes

justfile

@@ -5,14 +5,14 @@ DOCKER_FILE := "-f docker-compose.yml"
 
 install:
     #! /usr/bin/env sh
-    cd openverse-api
+    cd openverse_api
     pipenv install --dev
     pipenv run pre-commit install
 
 
 lint:
     #! /usr/bin/env sh
-    cd openverse-api
+    cd openverse_api
     pipenv run pre-commit run --all-files
 
 
@@ -38,7 +38,7 @@ test: up
 
 testlocal:
     #! /usr/bin/env sh
-    cd openverse-api
+    cd openverse_api
     pipenv run bash ./test/run_test.sh
 
 

openverse-api/Dockerfile → openverse_api/Dockerfile

@@ -10,21 +10,21 @@ ENV PYTHONBUFFERED 1
 RUN apt-get update \
     && apt-get install -y libexempi8 \
     && rm -rf /var/lib/apt/lists/* \
-    && mkdir /openverse-api \
-    && mkdir -p /var/log/openverse-api/openverse-api.log
+    && mkdir /openverse_api \
+    && mkdir -p /var/log/openverse_api/openverse_api.log
 
 ADD catalog/api/utils/fonts/SourceSansPro-Bold.ttf /usr/share/fonts/truetype/SourceSansPro-Bold.ttf
 
-WORKDIR /openverse-api
+WORKDIR /openverse_api
 
 # Install Python dependency management tools
 RUN pip install --upgrade pip \
     && pip install --upgrade setuptools \
     && pip install --upgrade pipenv
 
 # Copy the Pipenv files into the container
-COPY Pipfile /openverse-api/
-COPY Pipfile.lock /openverse-api/
+COPY Pipfile /openverse_api/
+COPY Pipfile.lock /openverse_api/
 
 # Install the dependencies system-wide
 # TODO: Use build args to avoid installing dev dependencies in production

openverse-api/catalog/api/docs/README.md → openverse_api/catalog/api/docs/README.md

@@ -1,6 +1,6 @@
 # Introduction
 
-The Openverse API ('openverse-api') is a system that allows programmatic access
+The Openverse API ('openverse_api') is a system that allows programmatic access
 to public domain digital media. It is our ambition to index and catalog billions
 of openly-licensed works, including articles, songs, videos, photographs,
 paintings, and more. Using this API, developers will be able to access the
@@ -98,7 +98,7 @@ $ curl \
 # Contribute
 
 We love pull requests! If you’re interested in
-[contributing on Github](https://github.com/wordpress/openverse-api), here’s a
+[contributing on Github](https://github.com/wordpress/openverse_api), here’s a
 todo list to get started.
 
 - Read up about [Django REST Framework](https://www.django-rest-framework.org/),
@@ -108,9 +108,9 @@ todo list to get started.
 - Read up about Documentation Guidelines, which provides guidelines on how to
   contribute to documentation, documentation styles and cheat sheet for drf-yasg
 - Run the server locally by following this
-  [link](https://github.com/wordpress/openverse-api#running-the-server-locally)
+  [link](https://github.com/wordpress/openverse_api#running-the-server-locally)
 - Update documentation or codebase
 - Make sure the updates passed the automated tests in this
-  [file](https://github.com/wordpress/openverse-api/blob/master/.github/workflows/integration-tests.yml)
+  [file](https://github.com/wordpress/openverse_api/blob/master/.github/workflows/integration-tests.yml)
 - Commit and push
 - Create pull request

openverse_api/catalog/api/tests.py

@@ -0,0 +1,3 @@
+from django.test import TestCase
+
+# Create your tests here.

openverse-api/catalog/api/utils/scheduled_tasks.py → openverse_api/catalog/api/utils/scheduled_tasks.py

@@ -14,7 +14,7 @@
 
 Even though there may be multiple instances of the server running, a job is
 guaranteed to execute only once. Jobs are not run unless it can acquire a lock
-inside of the cache (shared by all instances of openverse-api).
+inside of the cache (shared by all instances of openverse_api).
 """
 model_name_to_instance = {"Image": Image}
 

openverse-api/catalog/settings.py → openverse_api/catalog/settings.py

@@ -75,7 +75,7 @@
 
 if USE_S3:
     DEFAULT_FILE_STORAGE = "storages.backends.s3boto3.S3Boto3Storage"
-    AWS_STORAGE_BUCKET_NAME = os.getenv("LOGOS_BUCKET", "openverse-api-logos-prod")
+    AWS_STORAGE_BUCKET_NAME = os.getenv("LOGOS_BUCKET", "openverse_api-logos-prod")
     AWS_S3_SIGNATURE_VERSION = "s3v4"
     INSTALLED_APPS.append("storages")
 

openverse-api/catalog/urls/swagger.py → openverse_api/catalog/urls/swagger.py

@@ -15,7 +15,7 @@
     description = description_file.read()
 
 tos_url = "https://api.openverse.engineering/terms_of_service.html"
-license_url = "https://github.com/" "WordPress/openverse-api/blob/master/LICENSE"
+license_url = "https://github.com/" "WordPress/openverse_api/blob/master/LICENSE"
 logo_url = (
     "https://raw.githubusercontent.com/" "WordPress/openverse/master/brand/logo.svg"
 )