Initial commit

.github/ISSUE_TEMPLATE/bug_report.md

@@ -15,7 +15,7 @@ Steps to reproduce the behavior:
 
 > Ex.
 >
-> 1. Install stactools-ephemeral
+> 1. Install stactools-hwsd
 > 2. Run `scripts/test`
 > 3. See error
 

LICENSE

@@ -1,6 +1,6 @@
 This software is licensed under the Apache 2 license, quoted below.
 
-Copyright 2021 COMPANY [COMPANY WEBPAGE URL]
+Copyright 2021 Microsoft Corporation [https://microsoft.com/]
 
 Licensed under the Apache License, Version 2.0 (the "License"); you may not
 use this file except in compliance with the License. You may obtain a copy of

README.md

@@ -1,18 +1,37 @@
-# stactools-template
-
-This is a template repo used for creating new packages for `stactools`.
-
-## How to use
-
-1. Clone this template repository as your package name, e.g. `landsat`.
-   This name should be short, memorable, and a valid Python package name (i.e. it shouldn't start with a number, etc).
-   It can, however, include a hyphen, in which case the name for Python imports will be the underscored version, e.g. `landsat-8` goes to `stactools.landsat_8`.
-   Your name will be used on PyPI to publish the package in the stactools namespace, e.g. `stactools-landsat`.
-2. Change into the top-level directory of your package and run `scripts/rename`.
-   This will update _most_ of the files in the repository with your new package name.
-3. Update `setup.cfg` with your package description and such.
-4. Update the LICENSE with your company's information (or whomever holds the copyright).
-5. Run `sphinx-quickstart` in the `docs` directory to create the documentation template.
-6. Update `docs/installation_and_basic_usage.ipynb` to provide an interactive notebook to help users get started. Include the following badge at the top of the README to launch the notebook: [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/stactools-packages/template/main?filepath=docs/installation_and_basic_usage.ipynb). Be sure to modify the badge href to match your package repo.
-7. Add example Items (and Collections and Catalogs, if included) to a `examples/` directory.
-8. Delete this file, and rename `README-template.md` to `README.md`. Update your new README to provide information about how to use your package.
+[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/stactools-packages/hwsd/main?filepath=docs/installation_and_basic_usage.ipynb)
+
+# stactools-hwsd
+
+- Name: hwsd
+- Package: `stactools.hwsd`
+- PyPI: https://pypi.org/project/stactools-hwsd/
+- Owner: @jamesvrt
+- Dataset homepage: http://example.com
+- STAC extensions used:
+  - [proj](https://github.com/stac-extensions/projection/)
+  - [scientific](https://github.com/stac-extensions/scientific/)
+  - [item-assets](https://github.com/stac-extensions/item-assets/)
+  - [raster](https://github.com/stac-extensions/raster/)
+
+A short description of the package and its usage.
+
+## Examples
+
+### STAC objects
+
+- [Collection](examples/collection.json)
+- [Item](examples/item/item.json)
+
+### Command-line usage
+
+Description of the command line functions
+
+```bash
+$ stac hwsd create-item -s source -d destination
+
+$ stac hwsd create-collection -d destination
+
+$ stac hwsd populate-collection -s source -d destination
+```
+
+Use `stac hwsd --help` to see all subcommands and options.

docker_env

@@ -1,7 +1,7 @@
 DOCKER_REGISTRY=ghcr.io
 DOCKER_ORG=stactools-packages
-DOCKER_REPO=ephemeral
+DOCKER_REPO=hwsd
 DOCKER_TAG=local
 DOCKER_TAG_DEV=local-dev
-DOCKER_WORKDIR=/opt/stactools-ephemeral
-DOCKER_NAMESPACE_PACKAGE_DIR=stactools/ephemeral
+DOCKER_WORKDIR=/opt/stactools-hwsd
+DOCKER_NAMESPACE_PACKAGE_DIR=stactools/hwsd

docs/installation_and_basic_usage.ipynb

@@ -28,7 +28,7 @@
    "cell_type": "code",
    "execution_count": null,
    "source": [
-    "!pip install stactools-ephemeral"
+    "!pip install stactools-hwsd"
    ],
    "outputs": [],
    "metadata": {}
@@ -67,7 +67,7 @@
    "cell_type": "code",
    "execution_count": null,
    "source": [
-    "!stac ephemeral --help"
+    "!stac hwsd --help"
    ],
    "outputs": [],
    "metadata": {}
@@ -83,7 +83,7 @@
    "cell_type": "code",
    "execution_count": null,
    "source": [
-    "!stac ephemeral create-item --help"
+    "!stac hwsd create-item --help"
    ],
    "outputs": [],
    "metadata": {}
@@ -106,10 +106,9 @@
    "cell_type": "code",
    "execution_count": null,
    "source": [
-    "# Alter these with examples to match your package\n",
-    "from stactools.ephemeral import stac, cog\n",
+    "from stactools.hwsd import stac, cog\n",
     "\n",
-    "stac.create_item()\n",
+    "stac.create_item(\"path/to/data/assets/\")\n",
     "stac.create_collection()\n",
     "cog.create_cog()"
    ],

environment.yml

@@ -1,4 +1,4 @@
-name: stactools-ephemeral
+name: stactools-hwsd
 channels:
   - conda-forge
   - defaults