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

polarsteps_data_parser/utils.py

@@ -1,71 +1,71 @@
-import json
-from datetime import datetime
-from pathlib import Path
-
-import click
-
-
-def load_json_from_file(path: Path) -> dict:
-    """Load content from file and convert to JSON object.
-
-    Args:
-        path: path to file
-
-    Returns:
-        dict: parsed JSON
-    """
-    with open(path, "r") as file:
-        return json.load(file)
-
-
-def parse_date(date: str) -> datetime:
-    """Convert a string containing a timestamp to a datetime object.
-
-    Args:
-        date: unix timestamp
-
-    Returns:
-        datetime: timestamp parsed to a datetime object
-
-    """
-    timestamp = float(date)
-    date_time = datetime.fromtimestamp(timestamp)
-    return date_time
-
-
-def find_folder_by_id(folder_id: str) -> Path | None:
-    """Finds and returns the path of a folder within the base_directory that matches the given folder_id.
-
-    Args:
-        folder_id (str): The ID to search for in the folder names.
-
-    Returns:
-        Path or None: The path of the matching folder, or None if no matching folder is found.
-    """
-    base_path = Path(click.get_current_context().params["input_folder"])
-
-    for folder in base_path.iterdir():
-        if folder.is_dir() and folder.name.endswith(f"_{folder_id}"):
-            return folder
-    return None
-
-
-def list_files_in_folder(folder_path: Path, dir_has_to_exist: bool = True) -> list[Path]:
-    """List all files in the given folder.
-
-    Args:
-        folder_path (str or Path): The path of the folder to list files from.
-        dir_has_to_exist (bool): raise exception if path does not exist.
-
-    Returns:
-        List[Path]: A list of Path objects representing the files in the folder.
-
-    """
-    folder = Path(folder_path)
-
-    if not folder.is_dir():
-        if dir_has_to_exist:
-            raise NotADirectoryError(f"{folder_path} is not a valid directory")
-        return []
-
-    return [file for file in folder.iterdir() if file.is_file()]
+import json
+from datetime import datetime
+from pathlib import Path
+
+import click
+
+
+def load_json_from_file(path: Path) -> dict:
+    """Load content from file and convert to JSON object.
+
+    Args:
+        path: path to file
+
+    Returns:
+        dict: parsed JSON
+    """
+    with open(path, "r") as file:
+        return json.load(file)
+
+
+def parse_date(date: str) -> datetime:
+    """Convert a string containing a timestamp to a datetime object.
+
+    Args:
+        date: unix timestamp
+
+    Returns:
+        datetime: timestamp parsed to a datetime object
+
+    """
+    timestamp = float(date)
+    date_time = datetime.fromtimestamp(timestamp)
+    return date_time
+
+
+def find_folder_by_id(folder_id: str) -> Path | None:
+    """Finds and returns the path of a folder within the base_directory that matches the given folder_id.
+
+    Args:
+        folder_id (str): The ID to search for in the folder names.
+
+    Returns:
+        Path or None: The path of the matching folder, or None if no matching folder is found.
+    """
+    base_path = Path(click.get_current_context().params["input_folder"])
+
+    for folder in base_path.iterdir():
+        if folder.is_dir() and folder.name.endswith(f"_{folder_id}"):
+            return folder
+    return None
+
+
+def list_files_in_folder(folder_path: Path, dir_has_to_exist: bool = True) -> list[Path]:
+    """List all files in the given folder.
+
+    Args:
+        folder_path (str or Path): The path of the folder to list files from.
+        dir_has_to_exist (bool): raise exception if path does not exist.
+
+    Returns:
+        List[Path]: A list of Path objects representing the files in the folder.
+
+    """
+    folder = Path(folder_path)
+
+    if not folder.is_dir():
+        if dir_has_to_exist:
+            raise NotADirectoryError(f"{folder_path} is not a valid directory")
+        return []
+
+    return [file for file in folder.iterdir() if file.is_file()]

{polarsteps_data_parser-0.1.0.dist-info → polarsteps_data_parser-0.1.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: polarsteps-data-parser
-Version: 0.1.0
+Version: 0.1.1
 Summary: Parse and extract data from the data export of travel tracking app Polarsteps.
 Author-email: Niek van Leeuwen <ik@niekvanleeuwen.nl>
 License-Expression: MIT
@@ -24,44 +24,34 @@ Tool designed to parse and extract data from the travel tracking app [Polarsteps
 ## Getting started
 
 ### Installation
-To set up the project, ensure you have Python 3.11+ installed. Follow these steps:
-
-Clone the repository:
-
-```shell
-git clone https://github.com/niekvleeuwen/polarsteps-data-parser.git
-cd polarsteps-trip-analyzer
-```
-
-Ensure poetry is available, e.g. on Ubuntu/Debian you can run the following:
+To set up the project, ensure you have Python 3.11+ installed.
 
+Install from PyPI using pip:
 ```shell
-apt-get install python3 poetry
+pip install polarsteps-data-parser
 ```
 
-Install dependencies using Poetry:
+### Usage
+To get the following output, run `polarsteps-data-parser --help`.
 
 ```shell
-poetry install
-```
-
-Then enter the created virtual environment:
+Usage: polarsteps-data-parser [OPTIONS] INPUT_FOLDER
 
-```shell
-poetry shell
-```
+  Parse the data from a Polarsteps trip export.
 
-### Usage
-To run the project, use the following command:
+  INPUT_FOLDER should contain the Polarsteps data export of one (!) trip. Make
+  sure the folder contains a `trip.json` and `locations.json`.
 
-```shell
-polarsteps-data-parser [OPTIONS]
+Options:
+  --output TEXT           Output PDF file name  [default: Trip report.pdf]
+  --enrich-with-comments  Whether to enrich the trip with comments or not.
+  --help                  Show this message and exit.
 ```
 
 For example, to load and analyse a trip with the data located in the `./data/trip1` folder and enrich the trip with comments, use the following command:
 
 ```shell
-polarsteps-data-parser --input-folder ./data/trip1 --enrich-comments
+polarsteps-data-parser ./data/trip1 --enrich-with-comments
 ```
 
 ## Disclaimer

polarsteps_data_parser-0.1.1.dist-info/RECORD

@@ -0,0 +1,10 @@
+polarsteps_data_parser/__main__.py,sha256=rn-Yz_5KAXsCrsu5LjQLHFFEqc4sKxhSpcHgvnjlNxk,2419
+polarsteps_data_parser/model.py,sha256=v8hSCWRs82_Hur5EnsSETcQCv06LPx0lOgFo478CwrU,3704
+polarsteps_data_parser/pdf_generator.py,sha256=Neiz96urBlLOXJ80MDTYmlMX-mYOwuaW7QVHokVAJis,5510
+polarsteps_data_parser/retrieve_step_comments.py,sha256=AVcgZ_0iG91CKCHwgLjX7YfeVpa4P2XZ0GchPTbzZGs,3970
+polarsteps_data_parser/utils.py,sha256=_PKy-5VFEEtPXQtNyxogs1GZqPr_16cpLMtfTc75skM,1901
+polarsteps_data_parser-0.1.1.dist-info/METADATA,sha256=Zo0TkxYSAUYi2060qFVsEnzJTfewE1iKeX2POttP3d8,2626
+polarsteps_data_parser-0.1.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+polarsteps_data_parser-0.1.1.dist-info/entry_points.txt,sha256=UyGRCnpI13JtHPVilcSVgUSDNEYyv8-EQWgiJm-_ABg,79
+polarsteps_data_parser-0.1.1.dist-info/licenses/LICENSE,sha256=hxqP9qEfnLOSMQQMvUWQ4g-GOG6pny7O0_9AExvE-xU,1072
+polarsteps_data_parser-0.1.1.dist-info/RECORD,,

polarsteps_data_parser-0.1.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Niek van Leeuwen
+
+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.

polarsteps_data_parser-0.1.0.dist-info/RECORD

@@ -1,10 +0,0 @@
-polarsteps_data_parser/__main__.py,sha256=LgDdFfqviXCKd9ytERb3cGxgyNJ5hY6pYg1Y20SUIJA,2493
-polarsteps_data_parser/model.py,sha256=8-ekrANj-SV_AafWwS_kmPqNoFTMZXpj7Mb1X-kpXwA,3851
-polarsteps_data_parser/pdf_generator.py,sha256=WX50wR5lPNaAHz9830zqxkqlBIaBZ3YkzKNRZ4VMXxc,5665
-polarsteps_data_parser/retrieve_step_comments.py,sha256=oTaAT05vl-bFrICE5TId0OV2gCKQH3iLkrKFCiSpk7g,4105
-polarsteps_data_parser/utils.py,sha256=K5TYZIZEMEv4p332h6zDLA5rdpslARbHw7bCJ9Os45k,1972
-polarsteps_data_parser-0.1.0.dist-info/METADATA,sha256=2OUrp2m30N2X41TXintN0GTR8aOVo61cS_f-q1Jt1FI,2527
-polarsteps_data_parser-0.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-polarsteps_data_parser-0.1.0.dist-info/entry_points.txt,sha256=UyGRCnpI13JtHPVilcSVgUSDNEYyv8-EQWgiJm-_ABg,79
-polarsteps_data_parser-0.1.0.dist-info/licenses/LICENSE,sha256=IwGE9guuL-ryRPEKi6wFPI_zOhg7zDZbTYuHbSt_SAk,35823
-polarsteps_data_parser-0.1.0.dist-info/RECORD,,