{"id":13735026,"url":"https://github.com/stac-utils/stactools","last_synced_at":"2025-06-23T17:12:29.740Z","repository":{"id":37127108,"uuid":"288851778","full_name":"stac-utils/stactools","owner":"stac-utils","description":"Command line utility and Python library for STAC","archived":false,"fork":false,"pushed_at":"2024-06-24T12:06:37.000Z","size":40670,"stargazers_count":105,"open_issues_count":38,"forks_count":28,"subscribers_count":14,"default_branch":"main","last_synced_at":"2024-11-08T16:50:06.868Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://stactools.readthedocs.io/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stac-utils.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2020-08-19T22:36:21.000Z","updated_at":"2024-10-16T23:09:15.000Z","dependencies_parsed_at":"2023-11-29T04:37:56.597Z","dependency_job_id":"d6127931-e94b-4862-99b5-a652b2dc4648","html_url":"https://github.com/stac-utils/stactools","commit_stats":{"total_commits":616,"total_committers":25,"mean_commits":24.64,"dds":0.5762987012987013,"last_synced_commit":"80ca94b571ab89ad740b7692d062be5f4c131af3"},"previous_names":[],"tags_count":32,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stac-utils%2Fstactools","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stac-utils%2Fstactools/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stac-utils%2Fstactools/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stac-utils%2Fstactools/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stac-utils","download_url":"https://codeload.github.com/stac-utils/stactools/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224727173,"owners_count":17359532,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-03T03:01:02.280Z","updated_at":"2025-05-08T11:32:26.173Z","avatar_url":"https://github.com/stac-utils.png","language":"Python","funding_links":[],"categories":["`Python` processing of optical imagery (non deep learning)","Python"],"sub_categories":["Cloud Native Geospatial"],"readme":"# stactools\n\n\u003e [!WARNING]\n\u003e This repo does not have an active maintainer.\n\u003e If you'd like to help with maintenance, please open an [issue](https://github.com/stac-utils/stactools/issues) saying as much.\n\u003e For more background, see [this discussion](https://github.com/radiantearth/stac-spec/discussions/1331).\n\n![Build Status](https://github.com/stac-utils/stactools/workflows/CI/badge.svg)\n[![Documentation](https://readthedocs.org/projects/stactools/badge/?version=latest)](https://stactools.readthedocs.io/en/latest/)\n[![PyPI version](https://img.shields.io/pypi/v/stactools)](https://pypi.org/project/stactools/)\n[![Conda (channel only)](https://img.shields.io/conda/vn/conda-forge/stactools)](https://anaconda.org/conda-forge/stactools)\n[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\n\n`stactools` is a high-level command line tool and Python library for working with [STAC](https://stacspec.org).\nIt is based on [PySTAC](https://github.com/stac-utils/pystac).\n\nThis is the core `stactools` repository, which provides a basic command line interface (CLI) and API for working with STAC catalogs.\nThere are a suite of packages available in other repositories for working with a variety of datasets and for doing more complicated operations on STAC data.\nSee [packages](#packages) for more information.\n\n## Table of Contents\n\n- [Installation](#installation)\n- [Running](#running)\n- [Documentation](#documentation)\n- [Packages](#packages)\n- [Developing](#developing)\n\n## Installation\n\nTo install the latest version via pip:\n\n```sh\npip install stactools\n```\n\nTo install the latest version with [conda](https://docs.conda.io/en/latest/):\n\n```sh\nconda install -c conda-forge stactools\n```\n\nTo install the latest development version from the source repository:\n\n```sh\ngit clone https://github.com/stac-utils/stactools.git\ncd stactools\npip install .\n```\n\n**NOTE:** In order to read and write Cloud Optimized Geotiffs, GDAL version 3.1 or greater is required.\nIf your system GDAL is older than version 3.1, consider using [Docker](#using-docker) or [Conda](#using-conda) to get a modern GDAL.\n\n### Optional dependencies\n\n`stactools` includes two optional dependency:\n\n- `s3`: Enables s3 hrefs via `fsspec` and `s3fs`\n- `validate`: Enables `stac validate` and `stac lint`\n\nTo install optional dependencies:\n\n```sh\npip install 'stactools[s3]'\npip install 'stactools[validate]'\n```\n\n### Docker\n\nTo download the Docker image from the registry:\n\n```sh\ndocker pull ghcr.io/stac-utils/stactools:latest\n```\n\n## Running\n\n```sh\nstac --help\n```\n\n### Running from docker\n\n```sh\ndocker run --rm ghcr.io/stac-utils/stactools:latest --help\n```\n\n## Documentation\n\nSee the [documentation page](https://stactools.readthedocs.io/) for the latest docs.\n\n## Packages\n\n`stactools` is comprised of many other sub-packages that provide library and CLI functionality.\nOfficially supported packages are hosted in the Github [`stactools-packages` organization](https://github.com/stactools-packages/stactools-packages.github.io), and other subpackages may be available from other sources.\n\nThere are over 25 packages that translate specific types of data into STAC,\nincluding imagery sources like\n[aster](https://github.com/stactools-packages/aster),\n[landsat](https://github.com/stactools-packages/landsat),\n[modis](https://github.com/stactools-packages/modis),\n[naip](https://github.com/stactools-packages/naip),\n[planet](https://github.com/stactools-packages/planet),\n[sentinel1](https://github.com/stactools-packages/sentinel1),\n[sentinel1-grd](https://github.com/stactools-packages/sentinel1-grd),\n[sentinel2](https://github.com/stactools-packages/sentinel2),\n[sentinel3](https://github.com/stactools-packages/sentinel3), landuse/landcover\ndata ([corine](https://github.com/stactools-packages/corine),\n[cgls_lc100](https://github.com/stactools-packages/cgls_lc100),\n[aafc-landuse](https://github.com/stactools-packages/aafc-landuse)), Digital\nElevation Models (DEMs)\n([cop-dem](https://github.com/stactools-packages/cop-dem),\n[alos-dem](https://github.com/stactools-packages/alos-dem)), population data\n([gpw](https://github.com/stactools-packages/gpw),\n[worldpop](https://github.com/stactools-packages/worldpop)),\n[pointclouds](https://github.com/stactools-packages/pointcloud) and many more.\n\nThere are also cool tools like [stactools-browse](https://github.com/stactools-packages/stactools-browse) which makes it super easy to deploy a\n[STAC Browser](https://github.com/radiantearth/stac-browser) from the command line to browse any local data.\n\nFor the list of officially supported packages see the [list of STAC packages](https://github.com/stactools-packages/stactools-packages.github.io#list-of-stac-packages)\non the [stactools-packages GitHub organization](https://github.com/stactools-packages).\nEach package can be installed via `pip install stactools-{package}`, e.g. `pip install stactools-landsat`.\nThird-party packages can be installed in the same way, or, if they are not on PyPI, directly from the source repository, e.g. `pip install /path/to/my/code/stactools-greatdata`.\n\n## Developing\n\nClone the repository and install it in editable mode with the `dev` optional dependencies:\n\n```sh\ngit clone https://github.com/stac-utils/stactools.git\ncd stactools\npip install -e '.[dev]'\n```\n\nLinting and formatting are handled with [pre-commit](https://pre-commit.com/).\nYou will need to install pre-commit before committing any changes:\n\n```sh\npre-commit install\n```\n\nTests are handled with [pytest](https://docs.pytest.org/en/7.1.x/):\n\n```sh\npytest\n```\n\nRun a Juypter notebook:\n\n```sh\nscripts/notebook\n```\n\n### Using docker\n\nYou can also develop in a Docker container.\nBuild the container with:\n\n```sh\ndocker/build\n```\n\nOnce the container is built, you can run the `scripts/` scripts inside a docker console by running:\n\n```sh\ndocker/console\n```\n\nIn scenarios where you want to run scripts in `docker/` but don't want to run the build, images can be downloaded via the `pull` script:\n\n```sh\ndocker/pull\n```\n\nRun a [Juypter](https://jupyter.org/) notebook:\n\n```sh\ndocker/notebook\n```\n\nYou can run the CLI through docker by running:\n\n```sh\ndocker/stac --help\n```\n\n### Using conda\n\n[conda](https://docs.conda.io/en/latest/) is a useful tool for managing dependencies, both binary and Python-based.\nIf you have conda installed, you can create a new environment for `stactools` development by running the following command from the top-level directory in this repo:\n\n```sh\nconda env create -f environment.yml\n```\n\nThen activate the `stactools` environment:\n\n```sh\nconda activate stactools\n```\n\nFinally, install `stactools` in editable mode and all development requirements:\n\n```sh\npip install -e '.[dev]'\n```\n\n### Developing the docs\n\nTo build and serve the docs, the development requirements must be installed with `pip install -e '.[docs]'`.\nTo build the docs, you can use `make html` from inside of the docs directory, and to build the docs and start a server that watches for changes, use `make livehtml`:\n\n```sh\ncd docs\nmake html\nmake livehtml\n```\n\nIf using `make livehtml`, once the server starts, navigate to [http://localhost:8000](http://localhost:8000/) to see the docs.\nUse 'make' without arguments to see a list of available commands.\n\nYou can also run the previous commands in the docker container using:\n\n```sh\ndocker/console\n```\n\n### Code owners and repository maintainer(s)\n\nThis repository uses a [code owners file](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners) to automatically request reviews for new pull requests.\nThe current primary maintainer(s) of this repository are listed under the `*` rule in the [CODEOWNERS](./CODEOWNERS) file.\n\n### Adding a new package\n\nTo create a new `stactools` package, use the [`stactools` package template](https://github.com/stactools-packages/template).\n`stactools` utilizes Python's [namespace packages](https://packaging.python.org/guides/packaging-namespace-packages/) to provide a suite of tools all under the `stactools` namespace.\nIf you would like your package to be considered for inclusion as a core `stactools` package, please open an issue on this repository with a link to your package repository.\n\n### Releasing\n\nSee [RELEASING.md](./RELEASING.md) for the steps to create a new release.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstac-utils%2Fstactools","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstac-utils%2Fstactools","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstac-utils%2Fstactools/lists"}