diff --git a/.github/ISSUE_TEMPLATE/new_source_suggestion.yml b/.github/ISSUE_TEMPLATE/new_source_suggestion.yml index 8b916cef9cc..f225685b8c4 100644 --- a/.github/ISSUE_TEMPLATE/new_source_suggestion.yml +++ b/.github/ISSUE_TEMPLATE/new_source_suggestion.yml @@ -71,7 +71,7 @@ body: - The script must not use anything from `catalog/dags/retired/providers/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][pep8]. Please use `just lint` before committing. + - The script *must* conform to [PEP8][pep8]. Please use `./ov just lint` before committing. - 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). diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index b372475d2c4..340be3a8be0 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -24,9 +24,9 @@ Fixes #[issue number] by @[issue author] - [ ] I added or updated tests for the changes I made (if applicable). - [ ] I added or updated documentation (if applicable). - [ ] I tried running the project locally and verified that there are no visible errors. -- [ ] I ran the DAG documentation generator (`just catalog/generate-docs` for catalog - PRs) or the media properties generator (`just catalog/generate-docs media-props` - for the catalog or `just api/generate-docs` for the API) where applicable. +- [ ] I ran the DAG documentation generator (`./ov just catalog/generate-docs` for catalog + PRs) or the media properties generator (`./ov just catalog/generate-docs media-props` + for the catalog or `./ov just api/generate-docs` for the API) where applicable. [best_practices]: https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#_commit_guidelines diff --git a/.vale/README.md b/.vale/README.md index f00bf6f26ed..3dabd518a44 100644 --- a/.vale/README.md +++ b/.vale/README.md @@ -11,8 +11,8 @@ the Openverse monorepo, refer to the README at To run Vale with Openverse's configuration, use the just recipe: -``` -$ just .vale/run +```bash +./ov just .vale/run ``` This recipe _always_ builds Vale. The Openverse Vale docker image is fast to diff --git a/catalog/templates/template_test.py_template b/catalog/templates/template_test.py_template index 31ed808429b..733cd3ba920 100644 --- a/catalog/templates/template_test.py_template +++ b/catalog/templates/template_test.py_template @@ -3,7 +3,7 @@ TODO: Add additional tests for any methods you added in your subclass. Try to test edge cases (missing keys, different data types returned, Nones, etc). You may also need to update the given test names to be more specific. -Run your tests locally with `just test -k {provider_underscore}` +Run your tests locally with `./ov just catalog/test -k {provider_underscore}` """ import json diff --git a/catalog/tests/dags/providers/provider_api_scripts/test_cc_mixter.py b/catalog/tests/dags/providers/provider_api_scripts/test_cc_mixter.py index f0d4145890c..935b8ba6770 100644 --- a/catalog/tests/dags/providers/provider_api_scripts/test_cc_mixter.py +++ b/catalog/tests/dags/providers/provider_api_scripts/test_cc_mixter.py @@ -1,4 +1,4 @@ -"""Run these tests locally with `just test -k cc_mixter`""" +"""Run these tests locally with `./ov just catalog/test -k cc_mixter`""" import json from pathlib import Path diff --git a/catalog/tests/dags/providers/provider_api_scripts/test_inaturalist.py b/catalog/tests/dags/providers/provider_api_scripts/test_inaturalist.py index ce4eedc0cb3..6320bcdec42 100644 --- a/catalog/tests/dags/providers/provider_api_scripts/test_inaturalist.py +++ b/catalog/tests/dags/providers/provider_api_scripts/test_inaturalist.py @@ -31,7 +31,7 @@ # to pull a sample of records without breaking referential integrity. # - Putting your final zipped test files in /tests/s3-data/inaturalist-open-data # so that they will be synced over to minio. -# - Run `just down -v` and then `just recreate` to make sure that the test data gets to +# - Run `./ov just down -v` and then `./ov just recreate` to make sure that the test data gets to # the test s3 instance. That process may take on the order of 15 minutes for the full # dataset. You'll know that it's done when the s3-load container in docker exits. # - Then, in airflow, trigger the dag possibly with configuration diff --git a/docker/minio/load_to_s3_entrypoint.sh b/docker/minio/load_to_s3_entrypoint.sh index 67e53e39cbe..b106dae314a 100755 --- a/docker/minio/load_to_s3_entrypoint.sh +++ b/docker/minio/load_to_s3_entrypoint.sh @@ -1,7 +1,7 @@ #!/bin/bash # This does *not* allow for testing permissions issues that may come up in real AWS. -# And, if you remove files from /tests/s3-data, you will need to use `just down -v` -# and `just up` or `just recreate` to see the minio bucket without those files. +# And, if you remove files from /tests/s3-data, you will need to use `./ov just down -v` +# and `./ov just up` or `./ov just recreate` to see the minio bucket without those files. # Loop through subdirectories mounted to the volume and load them to s3/minio. # This takes care of filesystem delays on some local dev environments that may make # minio miss files included directly in the minio volume. diff --git a/documentation/api/guides/https.md b/documentation/api/guides/https.md index e23949fe393..ef002b333c2 100644 --- a/documentation/api/guides/https.md +++ b/documentation/api/guides/https.md @@ -19,7 +19,7 @@ Additionally, you will need to install 1. Create certificates for NGINX to use. ```bash - just docker/nginx/cert + ./ov just docker/nginx/cert ``` This will create a certificate file `openversse.crt` and a key file @@ -29,7 +29,7 @@ Additionally, you will need to install services. ```bash - just api/up + ./ov just api/up ``` The `api/up` recipe orchestrates the following services: `cache`, `db`, @@ -41,8 +41,8 @@ Additionally, you will need to install 3. Make an API call over HTTPS. ```bash - just api/stats images https://localhost:50243 - just _curl-get "images/stats/" https://localhost:50243 + ./ov just api/stats images https://localhost:50243 + ./ov just _curl-get "images/stats/" https://localhost:50243 curl "https://localhost:50243/v1/images/stats/" [{"source_name":"flickr","display_name":"Flickr","source_url":"https://www.flickr.com","logo_url":null,"media_count":2500},{"source_name":"stocksnap","display_name":"StockSnap","source_url":"https://stocksnap.io","logo_url":null,"media_count":2500}]% ``` diff --git a/documentation/api/guides/quickstart.md b/documentation/api/guides/quickstart.md index d554bf9fb93..2941f0b4b09 100644 --- a/documentation/api/guides/quickstart.md +++ b/documentation/api/guides/quickstart.md @@ -41,7 +41,7 @@ you need to run this. services. ```bash - just api/up + ./ov just api/up ``` The `api/up` recipe orchestrates the following services: `cache`, `db`, @@ -56,15 +56,15 @@ you need to run this. 4. Load the sample data. This step can take a few minutes to complete. ```bash - just api/init + ./ov just api/init ``` ````{admonition} Troubleshooting If this step fails, cleaning up and restarting usually fixes it. ```bash - just down -v - just api/init + ./ov just down -v + ./ov just api/init ``` ```` @@ -72,8 +72,8 @@ you need to run this. requests. ```bash - just api/stats - just _curl-get "images/stats/" http://localhost:50280 + ./ov just api/stats + ./ov just _curl-get "images/stats/" http://localhost:50280 curl "http://localhost:50280/v1/images/stats/" [{"source_name":"flickr","display_name":"Flickr","source_url":"https://www.flickr.com","logo_url":null,"media_count":2500},{"source_name":"stocksnap","display_name":"StockSnap","source_url":"https://stocksnap.io","logo_url":null,"media_count":2500}]% ``` @@ -84,7 +84,7 @@ you need to run this. transform it. ```bash - just api/stats | jq '.[0]' + ./ov just api/stats | jq '.[0]' { "source_name": "flickr", "display_name": "Flickr", @@ -93,7 +93,7 @@ you need to run this. "media_count": 2500 } - just api/stats 'audio' | jq '[.[] | .source_name]' + ./ov just api/stats 'audio' | jq '[.[] | .source_name]' [ "freesound", "jamendo", diff --git a/documentation/api/guides/test.md b/documentation/api/guides/test.md index b91480f7c85..971291f6e40 100644 --- a/documentation/api/guides/test.md +++ b/documentation/api/guides/test.md @@ -10,7 +10,7 @@ Once you've made some changes to the codebase, it is important to run tests. 2. Run the tests. ```bash - just api/test + ./ov just api/test ``` ```{note} diff --git a/documentation/automations/guides/quickstart.md b/documentation/automations/guides/quickstart.md index 22a456ea6fe..75e757303fe 100644 --- a/documentation/automations/guides/quickstart.md +++ b/documentation/automations/guides/quickstart.md @@ -12,7 +12,7 @@ you need to run this. ## Installation -`just install` in the repository root directory will install all Python and +`./ov just install` in the repository root directory will install all Python and Node.js dependencies for automations as well as other parts of the repository. If you wish to install only dependencies for automations, run the following: @@ -27,7 +27,7 @@ Run Python automation scripts using the `automations/python/run` just recipe. Ex.: ```bash -just automations/python/run print_labels.py +./ov just automations/python/run print_labels.py ``` The recipe is an alias for running `pipenv run