initial commit

This commit is contained in:
klein panic
2024-09-29 01:46:07 -04:00
commit ba6e6914d1
7576 changed files with 1356825 additions and 0 deletions

View File

@@ -0,0 +1,29 @@
BSD 3-Clause License
Copyright (c) 2021, GeoPandas
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

View File

@@ -0,0 +1,108 @@
Metadata-Version: 2.1
Name: xyzservices
Version: 2024.6.0
Summary: Source of XYZ tiles providers
Home-page: https://github.com/geopandas/xyzservices
Author: Dani Arribas-Bel, Martin Fleischmann
Author-email: daniel.arribas.bel@gmail.com, martin@martinfleischmann.net
License: 3-Clause BSD
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
# xyzservices - Source of XYZ tiles providers
`xyzservices` is a lightweight library providing a repository of available XYZ services
offering raster basemap tiles. The repository is provided via Python API and as a
compressed JSON file.
XYZ tiles can be used as background for your maps to provide necessary spatial context.
`xyzservices` offer specifications of many tile services and provide an easy-to-use
tools to plug them into your work, no matter if interactive or static.
[![Tests](https://github.com/geopandas/xyzservices/actions/workflows/tests.yaml/badge.svg)](https://github.com/geopandas/xyzservices/actions/workflows/tests.yaml) [![codecov](https://codecov.io/gh/geopandas/xyzservices/branch/main/graph/badge.svg?token=PBSZQA48GY)](https://codecov.io/gh/geopandas/xyzservices)
## Quick Start
Using `xyzservices` is simple and in most cases does not involve more than a line of
code.
### Installation
You can install `xyzservices` from `conda` or `pip`:
```shell
conda install xyzservices -c conda-forge
```
```shell
pip install xyzservices
```
The package does not depend on any other apart from those built-in in Python.
### Providers API
The key part of `xyzservices` are providers:
```py
>>> import xyzservices.providers as xyz
```
`xyzservices.providers` or just `xyz` for short is a `Bunch` of providers, an enhanced
`dict`. If you are in Jupyter-like environment, `xyz` will offer collapsible inventory
of available XYZ tile sources. You can also explore it as a standard `dict` using
`xyz.keys()`. Once you have picked your provider, you get its details as a
`TileProvider` object with all the details you may need:
```py
>>> xyz.CartoDB.Positron.url
'https://{s}.basemaps.cartocdn.com/{variant}/{z}/{x}/{y}{r}.png'
>>> xyz.CartoDB.Positron.attribution
'(C) OpenStreetMap contributors (C) CARTO'
```
You can also check if the `TileProvider` needs API token and pass it to the object if
needed.
```py
>>> xyz.MapBox.requires_token()
True
>>> xyz.MapBox["accessToken"] = "my_personal_token"
>>> xyz.MapBox.requires_token()
False
```
### Providers JSON
After the installation, you will find the JSON used as a database of providers in
`share/xyzservices/providers.json` if you want to use it outside of a Python ecosystem.
## Contributors
`xyzservices` is developed by a community of enthusiastic volunteers and lives under
[`geopandas`](https://github.com/geopandas) GitHub organization. You can see a full list
of contributors [here](https://github.com/geopandas/xyzservices/graphs/contributors).
The main group of providers is retrieved from the [`leaflet-providers`
project](https://github.com/leaflet-extras/leaflet-providers) that contains both openly
accessible providers as well as those requiring registration. All of them are considered
[free](https://github.com/leaflet-extras/leaflet-providers/blob/master/README.md#what-do-we-mean-by-free).
If you would like to contribute to the project, have a look at the list of
[open issues](https://github.com/geopandas/contextily/issues), particularly those labeled as
[good first issue](https://github.com/geopandas/xyzservices/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22).
## License
BSD 3-Clause License
Resources coming from the [`leaflet-providers`
project](https://github.com/leaflet-extras/leaflet-providers) are licensed under BSD
2-Clause License (© 2013 Leaflet Providers)

View File

@@ -0,0 +1,22 @@
../../../share/xyzservices/providers.json,sha256=bnvhyVzba3hg2I1ZmoWRCEFdsH6aWlPpnvlCQWRpW_0,711572
xyzservices-2024.6.0.dist-info/INSTALLER,sha256=zuuue4knoyJ-UwPPXg8fezS7VCrXJQrAP7zeNuwvFQg,4
xyzservices-2024.6.0.dist-info/LICENSE,sha256=2Ga4xsDnfmeyw_bSzKdx_8BfZbveFnTc8uDsVau2rWE,1517
xyzservices-2024.6.0.dist-info/METADATA,sha256=8NPtWzsbYkec6LVonySbZ7UOcK7BcDk0bpPePv3mHuk,3981
xyzservices-2024.6.0.dist-info/RECORD,,
xyzservices-2024.6.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
xyzservices-2024.6.0.dist-info/top_level.txt,sha256=0xGZr5GHGeVDjgd2TmcHd0jNgixeFzCQrPMvuWa67jo,12
xyzservices/__init__.py,sha256=t8ppYADbhZ3TB3poZFU_T5ZnNghSnZGVpQt5Hyc2Unw,256
xyzservices/__pycache__/__init__.cpython-311.pyc,,
xyzservices/__pycache__/lib.cpython-311.pyc,,
xyzservices/__pycache__/providers.cpython-311.pyc,,
xyzservices/data/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
xyzservices/data/__pycache__/__init__.cpython-311.pyc,,
xyzservices/data/providers.json,sha256=bnvhyVzba3hg2I1ZmoWRCEFdsH6aWlPpnvlCQWRpW_0,711572
xyzservices/lib.py,sha256=TA739fbUqUSQF8oWIgJ7Qgop6ZTorOxoh8qr5kBzGLk,21475
xyzservices/providers.py,sha256=H1mgw6L3giaTswv3DR3FTqho4YmBtpriL8wxrLb3dmE,333
xyzservices/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
xyzservices/tests/__pycache__/__init__.cpython-311.pyc,,
xyzservices/tests/__pycache__/test_lib.cpython-311.pyc,,
xyzservices/tests/__pycache__/test_providers.cpython-311.pyc,,
xyzservices/tests/test_lib.py,sha256=2KK2XbNtOFe5kNA3OzSU-hKpBfvtVX5r0X_xLj4Kcq8,9139
xyzservices/tests/test_providers.py,sha256=sjNjLzi0SEEcyH7d_0TcsQtQRLMp8nlqc3Eby7f4Xhk,6883

View File

@@ -0,0 +1,5 @@
Wheel-Version: 1.0
Generator: bdist_wheel (0.43.0)
Root-Is-Purelib: true
Tag: py3-none-any