Metadata-Version: 2.1
Name: tilejson
Version: 0.1.1
Summary: Create simple map viewer from TileJSON URL
Project-URL: Source, https://github.com/developmentseed/tilejson
Author-email: Vincent Sarago <vincent@developmentseed.com>
License: MIT License
        
        Copyright (c) 2023 Development Seed
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Scientific/Engineering :: GIS
Requires-Python: >=3.8
Requires-Dist: click
Requires-Dist: importlib-resources>=1.1.0; python_version < '3.9'
Requires-Dist: jinja2<4.0.0,>=2.11.2
Requires-Dist: starlette
Provides-Extra: dev
Requires-Dist: pre-commit; extra == 'dev'
Provides-Extra: test
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-cov; extra == 'test'
Description-Content-Type: text/markdown

# tilejson

<p align="center">
  <img max-width="800" src="https://user-images.githubusercontent.com/10407788/218823077-5c1567c9-79f0-4147-af92-0fe901986dff.gif"/>
  <p align="center">Create simple map viewer from TileJSON URL.</p>
</p>

<p align="center">
  <a href="https://github.com/developmentseed/tilejson/actions?query=workflow%3ACI" target="_blank">
      <img src="https://github.com/developmentseed/tilejson/workflows/CI/badge.svg" alt="Test">
  </a>
  <a href="https://codecov.io/gh/developmentseed/tilejson" target="_blank">
      <img src="https://codecov.io/gh/developmentseed/tilejson/branch/main/graph/badge.svg" alt="Coverage">
  </a>
  <a href="https://pypi.org/project/tilejson" target="_blank">
      <img src="https://img.shields.io/pypi/v/tilejson?color=%2334D058&label=pypi%20package" alt="Package version">
  </a>
  <a href="https://github.com/developmentseed/tilejson/blob/main/LICENSE" target="_blank">
      <img src="https://img.shields.io/github/license/developmentseed/tilejson.svg" alt="Downloads">
  </a>
</p>


## Install

You can install tilejson using pip

```bash
$ pip install tilejson
```

Build from source

```bash
$ git clone https://github.com/developmentseed/tilejson.git
$ cd tilejson
$ pip install -e .
```

## CLI

```bash
$ tilejson --help
Usage: tilejson [OPTIONS] URL

  tilejson cli.

Options:
  --no-geo           Create Map viewer for non-geo image.
  -o, --output PATH  Output file name.
  --help             Show this message and exit.
```

## How it works

The `tilejson` CLI will create simple map viewer (using [MapLibre](https://maplibre.org/projects/)) with a reference to the input tilejson URL.

By default the HTML code will be saved in a system temporary directory but user can pass an `--output` option to store the HTML file in a custom place.

Once the HTML document is created, `click` will [*launch*](https://click.palletsprojects.com/en/8.1.x/api/#click.launch) the page, opening it with the user's default browser.

## Contribution & Development

See [CONTRIBUTING.md](https://github.com/developmentseed/tilejson/blob/main/CONTRIBUTING.md)

## Authors

Created by [Development Seed](<http://developmentseed.org>)

## Changes

See [CHANGES.md](https://github.com/developmentseed/tilejson/blob/main/CHANGES.md).

## License

See [LICENSE.txt](https://github.com/developmentseed/tilejson/blob/main/LICENSE)
