polarsteps-data-parser 0.1.0__py3-none-any.whl → 0.1.1__py3-none-any.whl

polarsteps_data_parser/__main__.py

@@ -1,74 +1,74 @@
-import time
-from pathlib import Path
-
-import click
-from dotenv import load_dotenv
-
-from polarsteps_data_parser.retrieve_step_comments import StepCommentsEnricher
-from polarsteps_data_parser.model import Trip, Location
-from polarsteps_data_parser.pdf_generator import PDFGenerator
-from polarsteps_data_parser.utils import load_json_from_file
-
-
-@click.command()
-@click.argument(
-    "input-folder",
-    type=click.Path(exists=True, dir_okay=True, file_okay=False, readable=True),
-)
-@click.option(
-    "--output",
-    default="Trip report.pdf",
-    show_default=True,
-    help="Output PDF file name",
-)
-@click.option(
-    "--enrich-with-comments",
-    is_flag=True,
-    show_default=True,
-    default=False,
-    help="Whether to enrich the trip with comments or not.",
-)
-def cli(input_folder: str, output: str, enrich_with_comments: str) -> None:
-    """Parse the data from a Polarsteps trip export.
-
-    INPUT_FOLDER should contain the Polarsteps data export of one (!) trip. Make sure the folder contains
-    a `trip.json` and `locations.json`.
-    """
-    load_dotenv()
-
-    input_folder = Path(input_folder)
-    trip_data_path = input_folder / "trip.json"
-    location_data_path = input_folder / "locations.json"
-
-    if not trip_data_path.exists() or not location_data_path.exists():
-        log("Error: Cannot find Polarsteps trip in folder!")
-        log("Please make sure the input folder contains a `trip.json` and a `locations.json` file. ")
-        return
-
-    log("✅  Found Polarsteps trip", color="green", bold=True)
-    trip_data = load_json_from_file(trip_data_path)
-    location_data = load_json_from_file(location_data_path)
-
-    log("🔄 Starting to parse trip...", color="cyan")
-    trip = Trip.from_json(trip_data)
-
-    if enrich_with_comments is True:
-        StepCommentsEnricher(input_folder).enrich(trip)
-
-    [Location.from_json(data) for data in location_data["locations"]]  # TODO! use location data
-
-    log("🔄 Generating PDF...", color="cyan")
-    pdf_generator = PDFGenerator(output)
-    pdf_generator.generate_pdf(trip)
-    log(f"✅  Generated report: {click.format_filename(output)}", color="green", bold=True)
-
-
-def log(message: str, color: str = "white", bold: bool = False) -> None:
-    """Helper function to format messages."""
-    click.echo(click.style(f"[{time.strftime('%H:%M:%S')}] {message}", fg=color, bold=bold))
-
-
-if __name__ == "__main__":
-    load_dotenv()
-
-    cli()
+import time
+from pathlib import Path
+
+import click
+from dotenv import load_dotenv
+
+from polarsteps_data_parser.retrieve_step_comments import StepCommentsEnricher
+from polarsteps_data_parser.model import Trip, Location
+from polarsteps_data_parser.pdf_generator import PDFGenerator
+from polarsteps_data_parser.utils import load_json_from_file
+
+
+@click.command()
+@click.argument(
+    "input-folder",
+    type=click.Path(exists=True, dir_okay=True, file_okay=False, readable=True),
+)
+@click.option(
+    "--output",
+    default="Trip report.pdf",
+    show_default=True,
+    help="Output PDF file name",
+)
+@click.option(
+    "--enrich-with-comments",
+    is_flag=True,
+    show_default=True,
+    default=False,
+    help="Whether to enrich the trip with comments or not.",
+)
+def cli(input_folder: str, output: str, enrich_with_comments: str) -> None:
+    """Parse the data from a Polarsteps trip export.
+
+    INPUT_FOLDER should contain the Polarsteps data export of one (!) trip. Make sure the folder contains
+    a `trip.json` and `locations.json`.
+    """
+    load_dotenv()
+
+    input_folder = Path(input_folder)
+    trip_data_path = input_folder / "trip.json"
+    location_data_path = input_folder / "locations.json"
+
+    if not trip_data_path.exists() or not location_data_path.exists():
+        log("Error: Cannot find Polarsteps trip in folder!")
+        log("Please make sure the input folder contains a `trip.json` and a `locations.json` file. ")
+        return
+
+    log("✅  Found Polarsteps trip", color="green", bold=True)
+    trip_data = load_json_from_file(trip_data_path)
+    location_data = load_json_from_file(location_data_path)
+
+    log("🔄 Starting to parse trip...", color="cyan")
+    trip = Trip.from_json(trip_data)
+
+    if enrich_with_comments is True:
+        StepCommentsEnricher(input_folder).enrich(trip)
+
+    [Location.from_json(data) for data in location_data["locations"]]  # TODO! use location data
+
+    log("🔄 Generating PDF...", color="cyan")
+    pdf_generator = PDFGenerator(output)
+    pdf_generator.generate_pdf(trip)
+    log(f"✅  Generated report: {click.format_filename(output)}", color="green", bold=True)
+
+
+def log(message: str, color: str = "white", bold: bool = False) -> None:
+    """Helper function to format messages."""
+    click.echo(click.style(f"[{time.strftime('%H:%M:%S')}] {message}", fg=color, bold=bold))
+
+
+if __name__ == "__main__":
+    load_dotenv()
+
+    cli()

polarsteps_data_parser/model.py

@@ -1,147 +1,147 @@
-from dataclasses import dataclass
-from datetime import datetime, date
-from pathlib import Path
-from typing import Self
-
-from polarsteps_data_parser.utils import parse_date, find_folder_by_id, list_files_in_folder
-
-
-@dataclass
-class Location:
-    """Location as tracked by the travel tracker."""
-
-    lat: float
-    lon: float
-    time: datetime
-
-    @classmethod
-    def from_json(cls, data: dict) -> Self:
-        """Parse object from JSON data."""
-        return Location(lat=data["lat"], lon=data["lon"], time=parse_date(data["time"]))
-
-
-@dataclass
-class StepLocation:
-    """Location as provided by a step."""
-
-    lat: float
-    lon: float
-    name: str
-    country: str
-
-    @classmethod
-    def from_json(cls, data: dict) -> Self:
-        """Parse object from JSON data."""
-        return StepLocation(
-            lat=data["lat"],
-            lon=data["lon"],
-            name=data["name"],
-            country=data["detail"],
-        )
-
-
-@dataclass
-class Follower:
-    """Follower (can leave comments)."""
-
-    user_id: str
-    username: str
-    first_name: str
-    last_name: str
-
-    @classmethod
-    def from_json(cls, data: dict) -> Self:
-        """Parse object from JSON data."""
-        return Follower(
-            user_id=data["id"],
-            username=data["username"],
-            first_name=data["first_name"],
-            last_name=data["last_name"],
-        )
-
-    @property
-    def name(self) -> str:
-        """Name of the follower."""
-        return f"{self.first_name} {self.last_name}"
-
-
-@dataclass
-class StepComment:
-    """Comment connected to a step."""
-
-    comment_id: str
-    text: str
-    date: datetime
-    follower: Follower
-
-    @classmethod
-    def from_json(cls, data: dict) -> Self:
-        """Parse object from JSON data."""
-        return StepComment(
-            comment_id=data["id"],
-            text=data["text"],
-            date=parse_date(data["creation_time"]),
-            follower=Follower.from_json(data["user"]),
-        )
-
-
-@dataclass
-class Step:
-    """Polarsteps Step object."""
-
-    step_id: str
-    name: str
-    description: str
-    location: StepLocation
-    date: date
-    photos: list[Path]
-    videos: list[Path]
-    comments: list[StepComment]
-
-    @classmethod
-    def from_json(cls, data: dict) -> Self:
-        """Parse object from JSON data."""
-        s = Step(
-            step_id=data["id"],
-            name=data["name"] or data["display_name"],
-            description=data["description"],
-            location=StepLocation.from_json(data["location"]),
-            date=parse_date(data["start_time"]),
-            photos=[],
-            videos=[],
-            comments=[],
-        )
-        s.load_media()
-        return s
-
-    def load_media(self) -> None:
-        """Load photos and videos for the step."""
-        step_dir = find_folder_by_id(self.step_id)
-        if step_dir is None:
-            self.photos = []
-            self.videos = []
-        else:
-            self.photos = list_files_in_folder(step_dir / "photos", dir_has_to_exist=False)
-            self.videos = list_files_in_folder(step_dir / "videos", dir_has_to_exist=False)
-
-
-@dataclass
-class Trip:
-    """Polarsteps trip object."""
-
-    name: str
-    start_date: datetime
-    end_date: datetime
-    cover_photo_path: str
-    steps: list[Step]
-
-    @classmethod
-    def from_json(cls, data: dict) -> Self:
-        """Parse object from JSON data."""
-        return Trip(
-            name=data["name"],
-            start_date=parse_date(data.get("start_date")),
-            end_date=parse_date(data.get("end_date")),
-            cover_photo_path=data["cover_photo_path"],
-            steps=[Step.from_json(step) for step in data.get("all_steps")],
-        )
+from dataclasses import dataclass
+from datetime import datetime, date
+from pathlib import Path
+from typing import Self
+
+from polarsteps_data_parser.utils import parse_date, find_folder_by_id, list_files_in_folder
+
+
+@dataclass
+class Location:
+    """Location as tracked by the travel tracker."""
+
+    lat: float
+    lon: float
+    time: datetime
+
+    @classmethod
+    def from_json(cls, data: dict) -> Self:
+        """Parse object from JSON data."""
+        return Location(lat=data["lat"], lon=data["lon"], time=parse_date(data["time"]))
+
+
+@dataclass
+class StepLocation:
+    """Location as provided by a step."""
+
+    lat: float
+    lon: float
+    name: str
+    country: str
+
+    @classmethod
+    def from_json(cls, data: dict) -> Self:
+        """Parse object from JSON data."""
+        return StepLocation(
+            lat=data["lat"],
+            lon=data["lon"],
+            name=data["name"],
+            country=data["detail"],
+        )
+
+
+@dataclass
+class Follower:
+    """Follower (can leave comments)."""
+
+    user_id: str
+    username: str
+    first_name: str
+    last_name: str
+
+    @classmethod
+    def from_json(cls, data: dict) -> Self:
+        """Parse object from JSON data."""
+        return Follower(
+            user_id=data["id"],
+            username=data["username"],
+            first_name=data["first_name"],
+            last_name=data["last_name"],
+        )
+
+    @property
+    def name(self) -> str:
+        """Name of the follower."""
+        return f"{self.first_name} {self.last_name}"
+
+
+@dataclass
+class StepComment:
+    """Comment connected to a step."""
+
+    comment_id: str
+    text: str
+    date: datetime
+    follower: Follower
+
+    @classmethod
+    def from_json(cls, data: dict) -> Self:
+        """Parse object from JSON data."""
+        return StepComment(
+            comment_id=data["id"],
+            text=data["text"],
+            date=parse_date(data["creation_time"]),
+            follower=Follower.from_json(data["user"]),
+        )
+
+
+@dataclass
+class Step:
+    """Polarsteps Step object."""
+
+    step_id: str
+    name: str
+    description: str
+    location: StepLocation
+    date: date
+    photos: list[Path]
+    videos: list[Path]
+    comments: list[StepComment]
+
+    @classmethod
+    def from_json(cls, data: dict) -> Self:
+        """Parse object from JSON data."""
+        s = Step(
+            step_id=data["id"],
+            name=data["name"] or data["display_name"],
+            description=data["description"],
+            location=StepLocation.from_json(data["location"]),
+            date=parse_date(data["start_time"]),
+            photos=[],
+            videos=[],
+            comments=[],
+        )
+        s.load_media()
+        return s
+
+    def load_media(self) -> None:
+        """Load photos and videos for the step."""
+        step_dir = find_folder_by_id(self.step_id)
+        if step_dir is None:
+            self.photos = []
+            self.videos = []
+        else:
+            self.photos = list_files_in_folder(step_dir / "photos", dir_has_to_exist=False)
+            self.videos = list_files_in_folder(step_dir / "videos", dir_has_to_exist=False)
+
+
+@dataclass
+class Trip:
+    """Polarsteps trip object."""
+
+    name: str
+    start_date: datetime
+    end_date: datetime
+    cover_photo_path: str
+    steps: list[Step]
+
+    @classmethod
+    def from_json(cls, data: dict) -> Self:
+        """Parse object from JSON data."""
+        return Trip(
+            name=data["name"],
+            start_date=parse_date(data.get("start_date")),
+            end_date=parse_date(data.get("end_date")),
+            cover_photo_path=data["cover_photo_path"],
+            steps=[Step.from_json(step) for step in data.get("all_steps")],
+        )