Metadata-Version: 2.1
Name: quadbin
Version: 0.1.0a1
Summary: Hierarchical geospatial indexing system for square cells in Web Mercator projection
Home-page: https://github.com/cartodb/quadbin-py
Author: CARTO
Author-email: contact@carto.com
License: BSD 3-Clause
Keywords: quadbin,hierarchical,geospatial,index,visualization,maps,carto
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Microsoft :: Windows
Classifier: Topic :: Scientific/Engineering :: GIS
Requires-Python: >=2.7
Description-Content-Type: text/markdown

# quadbin-py

Python library for quadbin.

## Install

```bash
pip install quadbin
```

## Usage

```py
>>> import quadbin
>>> longitude = -3.7038
>>> latitude =  40.4168
>>> resolution = 10
>>> quadbin.point_to_cell(longitude, latitude, resolution)
5234261499580514303
```

## API

| Function |
|---|
| `cell_is_valid(index: int) -> bool` |
| `cell_to_tile(index: int) -> {"z","x","y"}` |
| `tile_to_cell(z: int, x: int, y: int) -> [longitude, latitude]` |
| `point_to_cell(longitude: float, latitude: float, resolution: int) -> int` |
| `get_resolution(index: int) -> int` |

## Development

Make commands:

- init: create the environment and install dependencies
- lint: run linter (flake8) + fix (black)
- test: run tests (pytest)
- publish-pypi: publish package in pypi.org
- publish-test-pypi: publish package in test.pypi.org
- clean: remove the environment


