ancient-map-tiler 0.1.0__py3-none-any.whl → 0.2.0__py3-none-any.whl

ancient_map_tiler/tiles.py

@@ -1,9 +1,7 @@
-import argparse
-import sys
-from argparse import Namespace
 from math import ceil, log
 from pathlib import Path
 
+import click
 import numpy as np
 import numpy.typing as npt
 from PIL import Image
@@ -155,36 +153,37 @@ def get_tiles_for_all_zoom_levels(
     return res
 
 
-def parse_args() -> Namespace:
-    parser = argparse.ArgumentParser(description="Create map tiles from a map source.")
-    parser.add_argument(
-        "map_source",
-        help="Path or identifier of the map source to generate tiles from",
-    )
-    parser.add_argument(
-        "--tile-size", "-t", help="Size of a tile", default=256, type=int
-    )
-    parser.add_argument(
-        "--output-directory",
-        "-o",
-        help="Output directory where to store the tiles, must not exist",
-        required=True,
-    )
-    parser.add_argument(
-        "--image-format",
-        "-f",
-        help="Output image format. Tested for .png and .webp",
-        default=".webp",
-    )
-    return parser.parse_args()
-
-
-def main() -> None:
-    args = parse_args()
-    map_source: str = args.map_source
+@click.command()
+@click.argument(
+    "map-source",
+    type=click.Path(exists=True),
+)
+@click.option(
+    "-o",
+    "--output-directory",
+    type=click.Path(),
+    help="Output directory where to store the tiles, must not exist",
+    required=True,
+)
+@click.option(
+    "-t", "--tile-size", help="Size of a tile. Default: 256", type=int, default=256
+)
+@click.option(
+    "--image-format",
+    "-f",
+    help="Output image format. Default: .webp .Tested for .png and .webp",
+    default=".webp",
+)
+def main(
+    map_source: str, output_directory: str, tile_size: int, image_format: str
+) -> None:
+    """map-source: Path or identifier of the map source to generate tiles from"""
+    output_directory = Path(output_directory)
+    assert not output_directory.exists(), f"{output_directory} must not exist"
+    click.echo(f"Loading {map_source}...")
     map_image = np.asarray(Image.open(map_source), dtype="uint8")
-    tiled_maps_by_zoom_level = get_tiles_for_all_zoom_levels(map_image, args.tile_size)
-    Path.mkdir(args.output_directory)
+    tiled_maps_by_zoom_level = get_tiles_for_all_zoom_levels(map_image, tile_size)
+    Path.mkdir(output_directory)
     nb_images_to_save = sum(
         tiled_map.shape[0] * tiled_map.shape[1]
         for tiled_map in tiled_maps_by_zoom_level
@@ -193,8 +192,8 @@ def main() -> None:
         for zoom_level, tiled_map in enumerate(tiled_maps_by_zoom_level):
             save_to_directory(
                 tiled_map,
-                Path(args.output_directory) / str(zoom_level),
-                image_format=args.image_format,
+                output_directory / str(zoom_level),
+                image_format=image_format,
                 progress_bar=progress_bar,
             )
 

{ancient_map_tiler-0.1.0.dist-info → ancient_map_tiler-0.2.0.dist-info}/METADATA

@@ -1,31 +1,48 @@
 Metadata-Version: 2.4
 Name: ancient-map-tiler
-Version: 0.1.0
-Summary: 
+Version: 0.2.0
+Summary: Provide tiles data for a web view of an ancient map
 Author: Noan Cloarec
 Author-email: noan.cloarec@gmail.com
 Requires-Python: >=3.13
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
-Requires-Dist: numpy (>=2.3.5,<3.0.0)
-Requires-Dist: tqdm (>=4.67.1,<5.0.0)
+Requires-Dist: click (>=8)
+Requires-Dist: numpy (>=2)
+Requires-Dist: tqdm (>=4)
 Description-Content-Type: text/markdown
 
 # Ancient-map-tiler
-This python project aims to provide tiles data for a web view of an ancient map
-The source image of the map may be very large. To be usable in a web view such as Leaflet it must be splitted into tiles at different zooms
-## Prerequisites
+This project aims to generate tiles data for a web view of any ancient map.  
+The source image of the map may be very large. To be usable in a web view such as Leaflet it must be splitted into tiles at different zooms.  
+
+## Usage
+```shell
+# (Optional) Download a large map from wikipedia
+wget https://upload.wikimedia.org/wikipedia/commons/5/50/TabulaPeutingeriana.jpg
+
+
+pip install ancient-map-tiler
+ancient-map-tiler TabulaPeutingeriana.jpg -o tiles
+```
+
+## Development
+### Prerequisites
  - python (tested on 3.13)
  - poetry
-## Usage
+ - pre-commit
+
+### Getting started
 ```shell
+git clone git@gitlab.com:noan-cloarec/ancient-map-tiler.git
 cd ancient-map-tiler
+
 poetry install
-# Download a large map from wikipedia
-wget https://upload.wikimedia.org/wikipedia/commons/5/50/TabulaPeutingeriana.jpg
+pre-commit install
+
 # Generate the tiles into a directory named tiles
-poetry run make_tiles TabulaPeutingeriana.jpg -o tiles
+poetry run ancient-map-tiler TabulaPeutingeriana.jpg -o tiles
 # Open the preview in your web browser
 open simple_map_preview.html
 ```

ancient_map_tiler-0.2.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+ancient_map_tiler/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ancient_map_tiler/tiles.py,sha256=2XPRIIJMTMiwfhv91F9HYt_trDpmQw9TF_tN33gqiT4,7867
+ancient_map_tiler-0.2.0.dist-info/METADATA,sha256=I7_ZKcQMRJKGLkJLzMKk5B67SXSV7YE6Cp8znYEkprk,1369
+ancient_map_tiler-0.2.0.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
+ancient_map_tiler-0.2.0.dist-info/entry_points.txt,sha256=mJS_XU5F_ra8fsrPcvogp13EZEU1CGk1vu2Aqe9WLm8,66
+ancient_map_tiler-0.2.0.dist-info/RECORD,,

ancient_map_tiler-0.2.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+ancient-map-tiler=ancient_map_tiler.tiles:main
+

ancient_map_tiler-0.1.0.dist-info/RECORD

@@ -1,6 +0,0 @@
-ancient_map_tiler/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ancient_map_tiler/tiles.py,sha256=cPpE4PTycdRSmVT-scLilc4g-Xz6XEJat3c7xxM-ah8,7889
-ancient_map_tiler-0.1.0.dist-info/METADATA,sha256=IxFxtnnUuTtwyAPf0kU_B4nTkTWaIjJbJvGoRKlDL1U,1065
-ancient_map_tiler-0.1.0.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
-ancient_map_tiler-0.1.0.dist-info/entry_points.txt,sha256=8g5jcREn9ACPtgJuvUtNSs3U1jviizdx0tBD772Brqc,59
-ancient_map_tiler-0.1.0.dist-info/RECORD,,

ancient_map_tiler-0.1.0.dist-info/entry_points.txt

@@ -1,3 +0,0 @@
-[console_scripts]
-make_tiles=ancient_map_tiler.tiles:main
-