cartons 1.0.0__tar.gz

cartons-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Andrej Bajusic
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

cartons-1.0.0/PKG-INFO

@@ -0,0 +1,9 @@
+Metadata-Version: 2.4
+Name: cartons
+Version: 1.0.0
+Summary: Simple OSRM routing and Folium map drawing toolkit
+Requires-Python: >=3.7
+License-File: LICENSE
+Requires-Dist: routingpy
+Requires-Dist: folium
+Dynamic: license-file

cartons-1.0.0/README.md

@@ -0,0 +1,116 @@
+# cartons
+
+A small Python toolkit for routing and map visualization.
+
+`cartons` calculates routes using **OSRM** (via `routingpy`) and draws them on an interactive **Leaflet map** using `folium`.
+
+With just a few lines of code you can compute a route between two coordinates and render it as an HTML map.
+
+It is designed to be simple, lightweight, and easy to integrate into scripts or small projects.
+
+---
+
+# Installation
+-not yet-
+Install from PyPI:
+
+```bash
+pip install cartons
+```
+
+Or install locally from the repository:
+
+```bash
+pip install -e .
+```
+
+Dependencies:
+
+- routingpy
+- folium
+
+---
+
+# Quick Example
+
+```python
+import cartons
+
+m = cartons.draw(
+    "https://router.project-osrm.org",
+    8.5417, 47.3769,
+    8.55, 47.38
+)
+
+m.save("route.html")
+```
+
+This generates an **interactive HTML map** showing the calculated route.
+
+---
+
+# How It Works
+
+The package has two main modules:
+
+```
+cartons/
+├ routing.py
+├ display.py
+└ __init__.py
+```
+
+### routing.py
+
+Handles communication with the OSRM routing engine using `routingpy`.
+
+It sends coordinates to the routing server and returns the full route response.
+
+### display.py
+
+Extracts route geometry and draws the route using `folium`.
+
+Coordinates returned by OSRM are converted from:
+
+```
+[lon, lat]
+```
+
+to
+
+```
+[lat, lon]
+```
+
+because Folium expects latitude first.
+
+---
+
+# Public OSRM Server
+
+The examples use the public demo server:
+
+```
+https://router.project-osrm.org
+```
+
+This server is suitable for testing and small scripts.
+
+For production usage, running your own OSRM server is recommended.
+
+---
+
+# Project Goals
+
+`cartons` aims to provide:
+
+- simple routing interface
+- quick map visualization
+- minimal dependencies
+- easy integration into Python scripts
+
+---
+
+# License
+
+MIT License

cartons-1.0.0/cartons/__init__.py

@@ -0,0 +1,2 @@
+from .routing import get_route
+from .display import draw

cartons-1.0.0/cartons/display.py

@@ -0,0 +1,15 @@
+from .routing import get_route
+import folium
+def draw(base_url, lon1, lat1, lon2, lat2, col, weight):
+
+    route = get_route(base_url, lon1, lat1, lon2, lat2)
+
+    routecoords = route.routes[0].geometry["coordinates"]
+    foliumcoords = [[lat, lon] for lon, lat in routecoords]
+    m = folium.Map(
+    location=(lat1, lon1),
+    control_scale=True,
+    )
+    folium.Polyline(
+        foliumcoords, color=col, weight=weight).add_to(m)
+    return m

cartons-1.0.0/cartons/routing.py

@@ -0,0 +1,11 @@
+from routingpy import OSRM
+
+def get_route(base_url, lon1, lat1, lon2,lat2):
+    router = OSRM(base_url=base_url)
+    coords = [
+        (lon1, lat1),
+        (lon2, lat2)]
+    route = router.directions(
+        locations = coords
+        )
+    return route

cartons-1.0.0/cartons.egg-info/PKG-INFO

@@ -0,0 +1,9 @@
+Metadata-Version: 2.4
+Name: cartons
+Version: 1.0.0
+Summary: Simple OSRM routing and Folium map drawing toolkit
+Requires-Python: >=3.7
+License-File: LICENSE
+Requires-Dist: routingpy
+Requires-Dist: folium
+Dynamic: license-file

cartons-1.0.0/cartons.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+LICENSE
+README.md
+pyproject.toml
+cartons/__init__.py
+cartons/display.py
+cartons/routing.py
+cartons.egg-info/PKG-INFO
+cartons.egg-info/SOURCES.txt
+cartons.egg-info/dependency_links.txt
+cartons.egg-info/requires.txt
+cartons.egg-info/top_level.txt

cartons-1.0.0/cartons.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

cartons-1.0.0/cartons.egg-info/requires.txt

@@ -0,0 +1,2 @@
+routingpy
+folium

cartons-1.0.0/cartons.egg-info/top_level.txt

@@ -0,0 +1 @@
+cartons

cartons-1.0.0/pyproject.toml

@@ -0,0 +1,14 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "cartons"
+version = "1.00.000"
+description = "Simple OSRM routing and Folium map drawing toolkit"
+requires-python = ">=3.7"
+
+dependencies = [
+  "routingpy",
+  "folium"
+]

cartons-1.0.0/setup.cfg

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