diff options
Diffstat (limited to 'python-xyzservices.spec')
| -rw-r--r-- | python-xyzservices.spec | 348 |
1 files changed, 348 insertions, 0 deletions
diff --git a/python-xyzservices.spec b/python-xyzservices.spec new file mode 100644 index 0000000..233056f --- /dev/null +++ b/python-xyzservices.spec @@ -0,0 +1,348 @@ +%global _empty_manifest_terminate_build 0 +Name: python-xyzservices +Version: 2023.2.0 +Release: 1 +Summary: Source of XYZ tiles providers +License: 3-Clause BSD +URL: https://github.com/geopandas/xyzservices +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/0d/3f/941a4e2abb9bc7d4c103d259902cd86ee9eae9914a4acdac441a6125bb69/xyzservices-2023.2.0.tar.gz +BuildArch: noarch + + +%description +# 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. + +[](https://github.com/geopandas/xyzservices/actions/workflows/tests.yaml) [](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) + + +%package -n python3-xyzservices +Summary: Source of XYZ tiles providers +Provides: python-xyzservices +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-xyzservices +# 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. + +[](https://github.com/geopandas/xyzservices/actions/workflows/tests.yaml) [](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) + + +%package help +Summary: Development documents and examples for xyzservices +Provides: python3-xyzservices-doc +%description help +# 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. + +[](https://github.com/geopandas/xyzservices/actions/workflows/tests.yaml) [](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) + + +%prep +%autosetup -n xyzservices-2023.2.0 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-xyzservices -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Tue Apr 11 2023 Python_Bot <Python_Bot@openeuler.org> - 2023.2.0-1 +- Package Spec generated |