tilekit 0.1.0__tar.gz → 0.2.1__tar.gz

tilekit-0.2.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

tilekit-0.2.1/PKG-INFO

@@ -0,0 +1,198 @@
+Metadata-Version: 2.4
+Name: tilekit
+Version: 0.2.1
+Summary: tilekit
+Author: zpz
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: torch
+Requires-Dist: tqdm
+Requires-Dist: opencv-python
+Requires-Dist: rasterio
+Requires-Dist: geopandas
+Dynamic: license-file
+
+
+# tilekit
+
+A lightweight toolkit for downloading Jilin-1 (JL1) XYZ Tile System (XYZ) / Tile Map Service (TMS) tiles and saving them as georeferenced Geographic Tagged Image File Format (GeoTIFF) files.
+
+`tilekit` wraps the low-level Hypertext Transfer Protocol (HTTP) requests, TMS/XYZ conversion, logging, and raster writing into a simple, high-level Application Programming Interface (API) based on `mercantile`, `rasterio`, and `Pillow`.
+
+## Features
+
+* **🗺 Bounding box download:** Construct tile lists from a longitude/latitude (lon/lat) bounding box and zoom level.
+* **📐 Shapefile-based download:** Use a polygon boundary (shapefile, European Petroleum Survey Group (EPSG): 4326) to determine the tile coverage.
+* **🔁 XYZ → TMS conversion:** Handles the JL1 API’s TMS-style Y coordinate internally, while filenames remain in standard XYZ format.
+* **⏸ Resume support / precheck:** Skips tiles that already exist on disk (`z/x/y.tif`) to avoid duplicate downloads.
+* **🧍 Human-like throttling:** Randomized delays between requests to mimic human behavior and reduce the risk of rate limiting.
+* **🧾 Structured logging:** Logs progress and errors both to the console and to `download.log` in the output folder.
+
+## Installation
+
+Once published on the Python Package Index (PyPI):
+
+```bash
+pip install tilekit
+```
+
+## Getting Started
+
+### 1. Download tiles by lon/lat bounding box
+
+```python
+from tilekit.downloader import TileDownloader
+
+def main():
+    min_lon = 114.98
+    max_lon = 117.20
+    min_lat = 38.69
+    max_lat = 41.18
+    zoom = 18
+
+    # JL1 API keys (replace with your own)
+    mk = "your_mk_token_here"
+    tk = "your_tk_token_here"
+
+    downloader = TileDownloader.from_lon_lat(
+        min_lat=min_lat,
+        max_lat=max_lat,
+        min_lon=min_lon,
+        max_lon=max_lon,
+        zoom=zoom,
+        mk=mk,
+        tk=tk,
+    )
+
+    print(f"Total tiles to download: {len(downloader.tile_list)}")
+
+    downloader.download_tiles(
+        output_folder=r"F:\xxx\JL1Tiles",
+        verbose_debug=False,
+    )
+
+if __name__ == '__main__':
+    main()
+
+```
+
+**This will:**
+
+* Compute all tiles covering the bounding box at zoom level 18.
+* Convert XYZ Y to JL1’s TMS convention internally.
+* Download each tile and save it as `z/x/y.tif` with proper georeferencing.
+
+### 2. Download tiles based on a shapefile boundary
+
+```python
+from tilekit.downloader import TileDownloader
+
+def main():
+    zoom = 18
+    mk = "your_mk_token_here"
+    tk = "your_tk_token_here"
+
+    # Shapefile should be in EPSG:4326 (lon/lat)
+    shp_path = r"beijing.shp"
+
+    downloader = TileDownloader.from_shp(
+        shp_path=shp_path,
+        zoom=zoom,
+        mk=mk,
+        tk=tk,
+    )
+
+    print(f"Total tiles to download: {len(downloader.tile_list)}")
+
+    downloader.download_tiles(
+        output_folder=r"F:\xxx\JL1Tiles",
+        verbose_debug=False,
+    )
+
+if __name__ == '__main__':
+    main()
+
+```
+
+**`from_shp` will:**
+
+* Read the shapefile using `geopandas`.
+* Reproject to EPSG:4326 if necessary.
+* Use the overall bounding box (`total_bounds`) to determine the tile range.
+
+> **Note:** `geopandas` is only required if you use `from_shp`. You can install it via `pip install geopandas`.
+
+## API Overview
+
+### `TileDownloader`
+
+```python
+from dataclasses import dataclass
+from typing import Sequence, Optional, Union
+from pathlib import Path
+import mercantile
+
+@dataclass
+class TileDownloader:
+    tile_list: Sequence[mercantile.Tile]
+    mk: str = "..."
+    tk: str = "..."
+    zoom: Optional[int] = None
+
+    def download_tiles(
+        self,
+        output_folder: Union[str, Path],
+        tile_list: Optional[Sequence[mercantile.Tile]] = None,
+        verbose_debug: bool = False,
+    ) -> None:
+        ...
+
+```
+
+**Key methods:**
+
+* `TileDownloader.from_lon_lat(min_lat, max_lat, min_lon, max_lon, zoom, mk, tk)`: Build a downloader from a bounding box.
+* `TileDownloader.from_shp(shp_path, zoom, mk, tk)`: Build a downloader from a shapefile boundary.
+* `TileDownloader.from_XYZs(tiles, mk, tk)`: Build a downloader from an existing list of `mercantile.Tile` objects (all at the same zoom level).
+* `TileDownloader.download_tiles(output_folder, tile_list=None, verbose_debug=False)`: Download all tiles and save as GeoTIFF files (`z/x/y.tif`), skipping files that already exist.
+
+## Output Format
+
+Each downloaded tile is saved as a multi-band GeoTIFF:
+
+* **Filename:** `output_folder/z/x/y.tif`
+* **Coordinate reference system:** EPSG:4326
+* **Transform:** Computed from the tile’s geographic bounds via `rasterio.transform.from_bounds`.
+* **Compression:** Lempel-Ziv-Welch (LZW) (`Compression.lzw`).
+* **Bands:** Derived from the source image (e.g., Red Green Blue (RGB) → 3 bands).
+
+## Requirements
+
+**Core dependencies** (installed automatically when you install `tilekit`):
+
+* `mercantile`
+* `rasterio`
+* `numpy`
+* `requests`
+* `Pillow`
+* `tqdm`
+
+**Optional dependencies** (for shapefile-based workflows):
+
+* `geopandas`
+
+## Notes
+
+* You must provide valid JL1 API keys (`mk`, `tk`) to access the tile service. The examples in this README use placeholder values; please replace them with your own.
+* The downloader includes:
+* A precheck step that skips already downloaded tiles.
+* Randomized delays between requests via `human_delay` to reduce the risk of being rate-limited.
+
+
+
+## License
+
+`tilekit` is released under the Apache 2.0 License.
+

tilekit-0.2.1/README.md

@@ -0,0 +1,182 @@
+
+# tilekit
+
+A lightweight toolkit for downloading Jilin-1 (JL1) XYZ Tile System (XYZ) / Tile Map Service (TMS) tiles and saving them as georeferenced Geographic Tagged Image File Format (GeoTIFF) files.
+
+`tilekit` wraps the low-level Hypertext Transfer Protocol (HTTP) requests, TMS/XYZ conversion, logging, and raster writing into a simple, high-level Application Programming Interface (API) based on `mercantile`, `rasterio`, and `Pillow`.
+
+## Features
+
+* **🗺 Bounding box download:** Construct tile lists from a longitude/latitude (lon/lat) bounding box and zoom level.
+* **📐 Shapefile-based download:** Use a polygon boundary (shapefile, European Petroleum Survey Group (EPSG): 4326) to determine the tile coverage.
+* **🔁 XYZ → TMS conversion:** Handles the JL1 API’s TMS-style Y coordinate internally, while filenames remain in standard XYZ format.
+* **⏸ Resume support / precheck:** Skips tiles that already exist on disk (`z/x/y.tif`) to avoid duplicate downloads.
+* **🧍 Human-like throttling:** Randomized delays between requests to mimic human behavior and reduce the risk of rate limiting.
+* **🧾 Structured logging:** Logs progress and errors both to the console and to `download.log` in the output folder.
+
+## Installation
+
+Once published on the Python Package Index (PyPI):
+
+```bash
+pip install tilekit
+```
+
+## Getting Started
+
+### 1. Download tiles by lon/lat bounding box
+
+```python
+from tilekit.downloader import TileDownloader
+
+def main():
+    min_lon = 114.98
+    max_lon = 117.20
+    min_lat = 38.69
+    max_lat = 41.18
+    zoom = 18
+
+    # JL1 API keys (replace with your own)
+    mk = "your_mk_token_here"
+    tk = "your_tk_token_here"
+
+    downloader = TileDownloader.from_lon_lat(
+        min_lat=min_lat,
+        max_lat=max_lat,
+        min_lon=min_lon,
+        max_lon=max_lon,
+        zoom=zoom,
+        mk=mk,
+        tk=tk,
+    )
+
+    print(f"Total tiles to download: {len(downloader.tile_list)}")
+
+    downloader.download_tiles(
+        output_folder=r"F:\xxx\JL1Tiles",
+        verbose_debug=False,
+    )
+
+if __name__ == '__main__':
+    main()
+
+```
+
+**This will:**
+
+* Compute all tiles covering the bounding box at zoom level 18.
+* Convert XYZ Y to JL1’s TMS convention internally.
+* Download each tile and save it as `z/x/y.tif` with proper georeferencing.
+
+### 2. Download tiles based on a shapefile boundary
+
+```python
+from tilekit.downloader import TileDownloader
+
+def main():
+    zoom = 18
+    mk = "your_mk_token_here"
+    tk = "your_tk_token_here"
+
+    # Shapefile should be in EPSG:4326 (lon/lat)
+    shp_path = r"beijing.shp"
+
+    downloader = TileDownloader.from_shp(
+        shp_path=shp_path,
+        zoom=zoom,
+        mk=mk,
+        tk=tk,
+    )
+
+    print(f"Total tiles to download: {len(downloader.tile_list)}")
+
+    downloader.download_tiles(
+        output_folder=r"F:\xxx\JL1Tiles",
+        verbose_debug=False,
+    )
+
+if __name__ == '__main__':
+    main()
+
+```
+
+**`from_shp` will:**
+
+* Read the shapefile using `geopandas`.
+* Reproject to EPSG:4326 if necessary.
+* Use the overall bounding box (`total_bounds`) to determine the tile range.
+
+> **Note:** `geopandas` is only required if you use `from_shp`. You can install it via `pip install geopandas`.
+
+## API Overview
+
+### `TileDownloader`
+
+```python
+from dataclasses import dataclass
+from typing import Sequence, Optional, Union
+from pathlib import Path
+import mercantile
+
+@dataclass
+class TileDownloader:
+    tile_list: Sequence[mercantile.Tile]
+    mk: str = "..."
+    tk: str = "..."
+    zoom: Optional[int] = None
+
+    def download_tiles(
+        self,
+        output_folder: Union[str, Path],
+        tile_list: Optional[Sequence[mercantile.Tile]] = None,
+        verbose_debug: bool = False,
+    ) -> None:
+        ...
+
+```
+
+**Key methods:**
+
+* `TileDownloader.from_lon_lat(min_lat, max_lat, min_lon, max_lon, zoom, mk, tk)`: Build a downloader from a bounding box.
+* `TileDownloader.from_shp(shp_path, zoom, mk, tk)`: Build a downloader from a shapefile boundary.
+* `TileDownloader.from_XYZs(tiles, mk, tk)`: Build a downloader from an existing list of `mercantile.Tile` objects (all at the same zoom level).
+* `TileDownloader.download_tiles(output_folder, tile_list=None, verbose_debug=False)`: Download all tiles and save as GeoTIFF files (`z/x/y.tif`), skipping files that already exist.
+
+## Output Format
+
+Each downloaded tile is saved as a multi-band GeoTIFF:
+
+* **Filename:** `output_folder/z/x/y.tif`
+* **Coordinate reference system:** EPSG:4326
+* **Transform:** Computed from the tile’s geographic bounds via `rasterio.transform.from_bounds`.
+* **Compression:** Lempel-Ziv-Welch (LZW) (`Compression.lzw`).
+* **Bands:** Derived from the source image (e.g., Red Green Blue (RGB) → 3 bands).
+
+## Requirements
+
+**Core dependencies** (installed automatically when you install `tilekit`):
+
+* `mercantile`
+* `rasterio`
+* `numpy`
+* `requests`
+* `Pillow`
+* `tqdm`
+
+**Optional dependencies** (for shapefile-based workflows):
+
+* `geopandas`
+
+## Notes
+
+* You must provide valid JL1 API keys (`mk`, `tk`) to access the tile service. The examples in this README use placeholder values; please replace them with your own.
+* The downloader includes:
+* A precheck step that skips already downloaded tiles.
+* Randomized delays between requests via `human_delay` to reduce the risk of being rate-limited.
+
+
+
+## License
+
+`tilekit` is released under the Apache 2.0 License.
+

tilekit-0.2.1/pyproject.toml

@@ -0,0 +1,27 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "tilekit"          # 包名（import 用这个）
+version = "0.2.1"
+description = "tilekit"
+authors = [{name = "zpz"}]
+readme = "README.md"
+requires-python = ">=3.8"
+
+dependencies = [
+    "numpy",
+    "torch",
+    "tqdm",
+    "opencv-python",
+    "rasterio",
+    "geopandas"
+]
+
+
+[tool.setuptools]
+package-dir = {"" = "src"}   # 关键：告诉它代码在 src 下面
+
+[tool.setuptools.packages.find]
+where = ["src"]

tilekit-0.2.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+