From b4d0ed12750fc1d67f8d17c7473fb65305ea77e3 Mon Sep 17 00:00:00 2001 From: Tyler Erickson Date: Mon, 4 Mar 2024 17:04:37 -0800 Subject: [PATCH] Capitalization consistency: STAC --- README.md | 2 +- src/pypgstac/python/pypgstac/db.py | 6 +++--- src/pypgstac/python/pypgstac/pypgstac.py | 8 ++++---- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index ea504b70..21d85e46 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ PgSTAC provides functionality for STAC Filters, CQL2 search, and utilities to help manage the indexing and partitioning of STAC Collections and Items. -PgSTAC is used in production to scale to hundreds of millions of STAC items. PgSTAC implements core data models and functions to provide a STAC API from a PostgreSQL database. PgSTAC is entirely within the database and does not provide an HTTP-facing API. The [Stac FastAPI](https://github.com/stac-utils/stac-fastapi) PgSTAC backend and [Franklin](https://github.com/azavea/franklin) can be used to expose a PgSTAC catalog. Integrating PgSTAC with any other language with PostgreSQL drivers is also possible. +PgSTAC is used in production to scale to hundreds of millions of STAC items. PgSTAC implements core data models and functions to provide a STAC API from a PostgreSQL database. PgSTAC is entirely within the database and does not provide an HTTP-facing API. The [STAC FastAPI](https://github.com/stac-utils/stac-fastapi) PgSTAC backend and [Franklin](https://github.com/azavea/franklin) can be used to expose a PgSTAC catalog. Integrating PgSTAC with any other language with PostgreSQL drivers is also possible. PgSTAC Documentation: https://stac-utils.github.io/pgstac/pgstac diff --git a/src/pypgstac/python/pypgstac/db.py b/src/pypgstac/python/pypgstac/db.py index d0b56a79..61da1df5 100644 --- a/src/pypgstac/python/pypgstac/db.py +++ b/src/pypgstac/python/pypgstac/db.py @@ -1,4 +1,4 @@ -"""Base library for database interaction with PgStac.""" +"""Base library for database interaction with PgSTAC.""" import atexit import logging import time @@ -53,7 +53,7 @@ class Settings(BaseSettings): class PgstacDB: - """Base class for interacting with PgStac Database.""" + """Base class for interacting with PgSTAC Database.""" def __init__( self, @@ -299,5 +299,5 @@ def func(self, function_name: str, *args: Any) -> Generator: return self.query(base_query, cleaned_args) def search(self, query: Union[dict, str, psycopg.types.json.Jsonb] = "{}") -> str: - """Search PgStac.""" + """Search PgSTAC.""" return dumps(next(self.func("search", query))[0]) diff --git a/src/pypgstac/python/pypgstac/pypgstac.py b/src/pypgstac/python/pypgstac/pypgstac.py index e92cb84f..a4684f6a 100644 --- a/src/pypgstac/python/pypgstac/pypgstac.py +++ b/src/pypgstac/python/pypgstac/pypgstac.py @@ -13,7 +13,7 @@ class PgstacCLI: - """CLI for PgStac.""" + """CLI for PgSTAC.""" def __init__( self, @@ -22,7 +22,7 @@ def __init__( debug: bool = False, usequeue: bool = False, ): - """Initialize PgStac CLI.""" + """Initialize PgSTAC CLI.""" if version: sys.exit(0) @@ -52,11 +52,11 @@ def pgready(self) -> None: self._db.wait() def search(self, query: str) -> str: - """Search PgStac.""" + """Search PgSTAC.""" return self._db.search(query) def migrate(self, toversion: Optional[str] = None) -> str: - """Migrate PgStac Database.""" + """Migrate PgSTAC Database.""" migrator = Migrate(self._db) return migrator.run_migration(toversion=toversion)