Metadata-Version: 2.1
Name: stac-nb
Version: 0.3.0
Summary: stac-nb exposes STAC in Jupyter Notebooks
Home-page: https://github.com/darrenwiens/stac-nb
Author: Darren Wiens
Author-email: dkwiens@gmail.com
License: MIT license
Project-URL: Documentation, https://stac-nb.readthedocs.io
Project-URL: Source, https://github.com/darrenwiens/stac-nb
Project-URL: Tracker, https://github.com/darrenwiens/stac-nb/issues
Keywords: stac_nb
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.6
Requires-Dist: ipywidgets (>=7.6.5)
Requires-Dist: jupyterlab (>=3.0.0)
Requires-Dist: pystac-client (>=0.3.0)

stac-nb
=================
STAC in Jupyter Notebooks
-------------------------

.. image:: https://readthedocs.org/projects/stac-nb/badge/?version=latest&style=flat
    :target: https://stac-nb.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status
.. image:: https://badge.fury.io/py/stac-nb.svg
    :target: https://badge.fury.io/py/stac-nb
    :alt: PyPI Status
.. image:: https://coveralls.io/repos/github/darrenwiens/stac-nb/badge.svg?branch=main
    :target: https://coveralls.io/github/darrenwiens/stac-nb?branch=main
.. image:: https://github.com/darrenwiens/stac-nb/actions/workflows/python-package.yml/badge.svg
    :alt: Build Status

Install
-------------------------
::

    pip install stac-nb

Usage
-------------------------

To use stac-nb in a project, start Jupyter Lab (``jupyter lab``), create a new notebook, then::

    from stac_nb import STAC_Query_UI

Display the UI for a STAC API::

    ui = STAC_Query_UI("https://earth-search.aws.element84.com/v0")
    ui.display()

After you have run the query, retrieve the results from ``ui.query_results``::

    ui.query_results


History
=======

0.1.0 (2021-10-02)
------------------

* First release on PyPI.

0.2.0 (2021-10-04)
------------------

* Added: optional filter by ids
* Added: optional print STAC query
* Updated: docs

0.3.0 (2021-10-06)
------------------

* Breaking Change: ``ui.query_results`` is now a list of ``pystac.item.Item``
* Added: automate builds and tests

