From f367518b05f898b6e0cf447413e4682fc632ad26 Mon Sep 17 00:00:00 2001 From: Edd Date: Fri, 20 Aug 2021 22:32:38 +0100 Subject: [PATCH 1/2] Changed all references from AGS-Validator or python-ags-api to pyagsapi Name for the project and API to be changed to pyagsapi --- .github/workflows/main.yml | 2 +- README.md | 16 +- app/main.py | 4 +- app/templates/index.html | 16 +- docs/README.md | 54 ++--- docs/_navbar.md | 6 - docs/_sidebar.md | 18 +- docs/api-spec-example.json | 453 ------------------------------------- docs/index.html | 10 +- docs/other/changelog.md | 1 - docs/other/faq.md | 1 - 11 files changed, 57 insertions(+), 524 deletions(-) delete mode 100644 docs/_navbar.md delete mode 100644 docs/api-spec-example.json delete mode 100644 docs/other/changelog.md delete mode 100644 docs/other/faq.md diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 1cc33b93..a1a437dd 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -15,7 +15,7 @@ on: env: REGISTRY: ghcr.io - IMAGE_NAME: python-ags-api + IMAGE_NAME: pyagsapi jobs: # Push image to GitHub Packages. diff --git a/README.md b/README.md index 4027816d..cef7f96b 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# AGS Utilities +# pyagsapi - AGS File Utilities API HTTP API for the [AGS Python library](https://gitlab.com/ags-data-format-wg/ags-python-library). @@ -12,7 +12,7 @@ Additionally .ags files can be validated for submission to the [National Geoscie ## Documentation -Read the docs at https://britishgeologicalsurvey.github.io/AGS-Validator/ for full documentation. +Read the docs at https://britishgeologicalsurvey.github.io/pyagsapi/ for full documentation. ## Quick start @@ -20,7 +20,7 @@ Read the docs at https://britishgeologicalsurvey.github.io/AGS-Validator/ for fu The simplest way to run the validation service is via Docker: ``` -docker run -p 80:80 --name ags-validator ghcr.io/britishgeologicalsurvey/python-ags-api +docker run -p 80:80 --name pyagsapi ghcr.io/britishgeologicalsurvey/pyagsapi ``` Navigate to [http://localhost](http://localhost) to see the landing page or @@ -30,8 +30,8 @@ the Swagger interface. The `latest` tag reflects the current state of the `main` branch of the repository. It may have breaking changes. -Use versions from tagged [Releases](https://github.com/BritishGeologicalSurvey/AGS-Validator/releases) to fix the version in deployment pipelines. -Available tags are listed in the [Package Registry](https://github.com/BritishGeologicalSurvey/AGS-Validator/pkgs/container/python-ags-api). +Use versions from tagged [Releases](https://github.com/BritishGeologicalSurvey/pyagsapi/releases) to fix the version in deployment pipelines. +Available tags are listed in the [Package Registry](https://github.com/BritishGeologicalSurvey/AGS-Validator/pkgs/container/pyagsapi). @@ -46,8 +46,8 @@ It runs on the [Uvicorn](https://www.uvicorn.org/) ASGI server. Use the following commands to run the API locally: ```bash -git clone https://github.com/BritishGeologicalSurvey/AGS-validator -cd AGS-validator +git clone https://github.com/BritishGeologicalSurvey/pyagsapi +cd pyagsapi pip install -r requirements.txt uvicorn app.main:app --reload ``` @@ -71,6 +71,6 @@ will start an IPython debugger session in the event of test failure. ### Licence -`AGS Validator` was created by and is maintained by the British Geological Survey. +`pyagsapi` was created by and is maintained by the British Geological Survey. It is distributed under the [LGPL v3.0 licence](LICENSE). Copyright: © BGS / UKRI 2021 diff --git a/app/main.py b/app/main.py index 83042023..7fa37349 100644 --- a/app/main.py +++ b/app/main.py @@ -80,14 +80,14 @@ def custom_openapi(): if app.openapi_schema: return app.openapi_schema openapi_schema = get_openapi( - title="AGS Python Libary API", + title="pyagsapi and AGS Python Library API", version="0.1.0", description=("This OpenAPI schema, Validate or convert your AGS files here. " "Validation is against the official AGS standard only."), routes=app.routes, ) openapi_schema["info"]["x-logo"] = { - "url": ("https://raw.githubusercontent.com/BritishGeologicalSurvey/AGS-Validator" + "url": ("https://raw.githubusercontent.com/BritishGeologicalSurvey/pyagsapi" "/main/app/static/img/BGS-Logo-Pos-RGB-01.png") } app.openapi_schema = openapi_schema diff --git a/app/templates/index.html b/app/templates/index.html index a17ee93f..dc0fc659 100644 --- a/app/templates/index.html +++ b/app/templates/index.html @@ -1,13 +1,13 @@ - AGS File Utilities + pyagsapi BGS Logo -

AGS File Utilities

+

pyagsapi - AGS File Utilities API


-

Validate or convert your AGS files here. Validation is against the official AGS standard only.

+

Validate or convert your AGS files here.