Skip to content

Codespell 20201013 #195

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 15, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Thank you to all the new contributors that contributed during STAC Sprint 6!
- Added support for the Projection extension([#125](https://github.com/azavea/pystac/pull/125))
- Add support for Item Asset properties ([#127](https://github.com/azavea/pystac/pull/127))
- Added support for dynamically changing the STAC version via `pystac.set_stac_version` and `pystac.get_stac_version` ([#130](https://github.com/azavea/pystac/pull/130))
- Added support for prerelease versions in version comparisions for the `pystac.serialization.identify` package ([#138](https://github.com/azavea/pystac/pull/138))
- Added support for prerelease versions in version comparisons for the `pystac.serialization.identify` package ([#138](https://github.com/azavea/pystac/pull/138))
- Added validation for PySTAC STACObjects as well as arbitrary STAC JSON ([#139](https://github.com/azavea/pystac/pull/139))
- Added the ability to read HTTP and HTTPS uris by default ([#139](https://github.com/azavea/pystac/pull/139))

Expand All @@ -70,18 +70,18 @@ asset extension renamed to item-assets and renamed assets field in Collections t

The two major changes for this release are:
- Upgrade to STAC 0.9.0
- Refactor the extensions API to accomidate items that implement multiple extesions (e.g. `eo` and `view`)
- Refactor the extensions API to accommodate items that implement multiple extensions (e.g. `eo` and `view`)

See the [stac-spec 0.9.0 changelog](https://github.com/radiantearth/stac-spec/blob/v0.9.0/CHANGELOG.md) and issue [#65](https://github.com/azavea/pystac/issues/65) for more information.

### API Changes

These are the major API changes that will have to be accounted for when upgrading PySTAC:

#### Extensions are wrappers around Catalogs, Collection and Items, and no longer inheret.
#### Extensions are wrappers around Catalogs, Collection and Items, and no longer inherit.

This change affects the two extensions that were implemented for Item - `EOItem` and `LabelItem`
have become `EOItemExt` and `LabelItemExt`, and no longer inheret from Item.
have become `EOItemExt` and `LabelItemExt`, and no longer inherit from Item.

This change was motivated by the 0.9 change that split some properties out from `eo` into
the `view` extension. If we kept an inheritance-based extension architecture, we would not
Expand Down Expand Up @@ -131,7 +131,7 @@ use `Band.create`

### Added

- Allow for backwards compatibilty for reading STAC [#77](https://github.com/azavea/pystac/pull/70)
- Allow for backwards compatibility for reading STAC [#77](https://github.com/azavea/pystac/pull/70)

### Fixed

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ __Note__: `nbsphinx` requires that a local `pystac` is installed; use `pip insta



## Runing the quickstart and tutorials
## Running the quickstart and tutorials

There is a quickstart and tutorials written as jupyter notebooks in the `docs/tutorials` folder.
To run the notebooks, run a jupyter notebook with the `docs` directory as the notebook directory:
Expand Down
4 changes: 2 additions & 2 deletions docs/concepts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -498,8 +498,8 @@ The ``pystac.serialization`` package has some functionality around working direc
JSON objects, without utilizing PySTAC object types. This is used internally by PySTAC, but might also be useful to users working directly with JSON (e.g. on validation).


Identifing STAC objects from JSON
---------------------------------
Identifying STAC objects from JSON
----------------------------------

Users can identify STAC information, including the object type, version and extensions,
from JSON. The main method for this is :func:`~pystac.serialization.identify_stac_object`,
Expand Down
4 changes: 2 additions & 2 deletions docs/tutorials/adding-new-and-custom-extensions.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@
"\n",
"### Implementing an ItemExtension\n",
"\n",
"We'll be referring to the [Satellite Extensions Specification](https://github.com/radiantearth/stac-spec/blob/v1.0.0-beta.2/extensions/sat/README.md) (refered to as the spec) to implement this extension.\n",
"We'll be referring to the [Satellite Extensions Specification](https://github.com/radiantearth/stac-spec/blob/v1.0.0-beta.2/extensions/sat/README.md) (referred to as the spec) to implement this extension.\n",
"\n",
"The `sat` extension (or in our case `space_camera` extension) is scoped to `Item`. That information is found in the \"Scope\" line at the top of the spec. We'll want to implement an `CatalogExtension`, `CollectionExtension`, and `ItemExtension` for each of the STAC object types in the scope. In this case, we're only implementing an `ItemExtension`."
]
Expand Down Expand Up @@ -192,7 +192,7 @@
"\n",
"An extension object works by modifying the Item (or whichever STAC object is being extended) directly through Python [property getters and setters](https://docs.python.org/3/library/functions.html#property). The getter should read directly from the `properties` or `extra_fields` in the item and perform any trasformations needed to convert to the relevant Python objects (e.g. transform a string into a `datetime` object). Likewise, the setter should take in Python objects and transform them to their serialized string, and set them in the appropriate place in item. This way the extension modifies the Item directly, and will not require any specialized serialization or deserialization logic. This also allows multiple extensions to be used to access and set information on the STAC object - a distinct advantage to the inheritance-based extension implementation that PySTAC used before 0.4.0.\n",
"\n",
"For the `sat` extension we have two properties to implement, both of which are straighforward and do not need any transformation in the getters and setters:"
"For the `sat` extension we have two properties to implement, both of which are straightforward and do not need any transformation in the getters and setters:"
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/creating-a-landsat-stac.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,7 @@
"\n",
"Landsat 8 metadata is contained in an `MTL` file that is alongside of the `download_url` file specified in the scene data. Let's read the MTL file for the first scene and see what it looks like.\n",
"\n",
"First we define a function that reads a file based on the `download_url` location - we'll be using this a lot to get file URLs releated to a scene:"
"First we define a function that reads a file based on the `download_url` location - we'll be using this a lot to get file URLs related to a scene:"
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/how-to-create-stac-catalogs.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -1556,7 +1556,7 @@
"source": [
"An Extent is comprised of a SpatialExtent and a TemporalExtent. These hold one or more bounding boxes and time intervals, respectively, that completely cover the items contained in the collections.\n",
"\n",
"Let's start with creating two new items - these will be core Items. We can set these items to implement the `eo` extension by specifing them in the `stac_extensions`."
"Let's start with creating two new items - these will be core Items. We can set these items to implement the `eo` extension by specifying them in the `stac_extensions`."
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/pystac-introduction.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -593,7 +593,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"Collections are Catalogs but also include spatial and temporal extents as well as addtitional properties. "
"Collections are Catalogs but also include spatial and temporal extents as well as additional properties. "
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/pystac-spacenet-tutorial.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
" - Save the STAC locally\n",
" - Download labels for and create COGs of each images\n",
" - Save the geojson labels and COGs locall\n",
" - Create an updated STAC that points to the new files and ony includes labeled scenes\n",
" - Create an updated STAC that points to the new files and only includes labeled scenes\n",
" - Set relative paths for all STAC object\n",
" - Normalize links from a root directory and save the STAC there"
]
Expand Down
2 changes: 1 addition & 1 deletion pystac/extensions/single_file_stac.py
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ def apply(self, features, collections=None):
features (List[Item]): List of items contained by
this SingleFileSTAC.
collections (List[Collection]): Optional list of collections that are
used by any of teh Items in the catalog.
used by any of the Items in the catalog.
"""
self.features = features
self.collections = collections
Expand Down
4 changes: 2 additions & 2 deletions pystac/validation/stac_validator.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ class STACValidator(ABC):
"""STACValidator defines methods for validating STAC
JSON. Implementations define methods for validating core objects and extension.
By default the JsonSchemaSTACValidator is used by PySTAC; users can define their own
STACValidator implemetnation and set that validator to be used by
STACValidator implementation and set that validator to be used by
pystac by using the :func:`~pystac.validation.set_validator` method.
"""
@abstractmethod
Expand Down Expand Up @@ -90,7 +90,7 @@ class JsonSchemaSTACValidator(STACValidator):
Args:
schema_uri_map (SchemaUriMap): The SchemaUriMap that defines where
the validator will retrieve the JSON schemas for validation.
Defautls to an instance of
Defaults to an instance of
:class:`~pystac.validation.schema_uri_map.DefaultSchemaUriMap`

Note:
Expand Down