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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -32,8 +32,6 @@ class PDFGenerator:
32
32
  self.generate_title_page(trip)
33
33
 
34
34
  for i, step in tqdm(enumerate(trip.steps), desc="Generating pages", total=len(trip.steps), ncols=80):
35
- if i == 5:
36
- break
37
35
  self.generate_step_pages(step)
38
36
 
39
37
  self.canvas.save()
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: polarsteps-data-parser
3
- Version: 0.1.1
3
+ Version: 0.1.2
4
4
  Summary: Parse and extract data from the data export of travel tracking app Polarsteps.
5
5
  Author-email: Niek van Leeuwen <ik@niekvanleeuwen.nl>
6
6
  License-Expression: MIT
@@ -21,18 +21,31 @@ Tool designed to parse and extract data from the travel tracking app [Polarsteps
21
21
  1. **Data backup**: The data export does not support viewing your data in any useful way. To preserve the data (who knows if Polarsteps still exists in 20 years), the tool combines the data and generates a PDF document.
22
22
  2. **Data analysis & visualization**: The parsed data can also be leveraged for in-depth analysis, enabling users to gain insights into their travel patterns, destinations visited, duration of stays, distances traveled, and more. This opens up possibilities for statistical analysis, trend identification, and visualization of the trip data.
23
23
 
24
+ ## Detailed Usage Guide
25
+
26
+ If you’re new to Python or command-line tools, I’ve created a step-by-step usage guide to help you install and run polarsteps-data-parser (no programming experience required).
27
+
28
+ 👉 Read the guide here: [Usage guide](https://github.com/niekvleeuwen/polarsteps-data-parser/blob/main/USAGE_GUIDE.md)
29
+
24
30
  ## Getting started
25
31
 
26
- ### Installation
27
- To set up the project, ensure you have Python 3.11+ installed.
28
32
 
29
- Install from PyPI using pip:
33
+ 1. Clone the repository and navigate to the project root:
34
+
35
+ ```shell
36
+ git clone https://github.com/niekvleeuwen/polarsteps-data-parser.git
37
+ cd polarsteps-data-parser
38
+ ```
39
+
40
+ 2. Install dependencies using [uv](https://docs.astral.sh/uv/).
41
+ Make sure `uv` is installed on your system before proceeding.
42
+
30
43
  ```shell
31
- pip install polarsteps-data-parser
44
+ uv sync
32
45
  ```
33
46
 
34
47
  ### Usage
35
- To get the following output, run `polarsteps-data-parser --help`.
48
+ To get the following output, run `uv run polarsteps-data-parser --help`.
36
49
 
37
50
  ```shell
38
51
  Usage: polarsteps-data-parser [OPTIONS] INPUT_FOLDER
@@ -51,7 +64,7 @@ Options:
51
64
  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:
52
65
 
53
66
  ```shell
54
- polarsteps-data-parser ./data/trip1 --enrich-with-comments
67
+ uv run polarsteps-data-parser ./data/trip1 --enrich-with-comments
55
68
  ```
56
69
 
57
70
  ## Disclaimer
@@ -1,10 +1,10 @@
1
1
  polarsteps_data_parser/__main__.py,sha256=rn-Yz_5KAXsCrsu5LjQLHFFEqc4sKxhSpcHgvnjlNxk,2419
2
2
  polarsteps_data_parser/model.py,sha256=v8hSCWRs82_Hur5EnsSETcQCv06LPx0lOgFo478CwrU,3704
3
- polarsteps_data_parser/pdf_generator.py,sha256=Neiz96urBlLOXJ80MDTYmlMX-mYOwuaW7QVHokVAJis,5510
3
+ polarsteps_data_parser/pdf_generator.py,sha256=JZoJaQ1LtpNYOwQpgrbsf7xd992AU7_Hlh0OQoAtwv8,5465
4
4
  polarsteps_data_parser/retrieve_step_comments.py,sha256=AVcgZ_0iG91CKCHwgLjX7YfeVpa4P2XZ0GchPTbzZGs,3970
5
5
  polarsteps_data_parser/utils.py,sha256=_PKy-5VFEEtPXQtNyxogs1GZqPr_16cpLMtfTc75skM,1901
6
- polarsteps_data_parser-0.1.1.dist-info/METADATA,sha256=Zo0TkxYSAUYi2060qFVsEnzJTfewE1iKeX2POttP3d8,2626
7
- polarsteps_data_parser-0.1.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
8
- polarsteps_data_parser-0.1.1.dist-info/entry_points.txt,sha256=UyGRCnpI13JtHPVilcSVgUSDNEYyv8-EQWgiJm-_ABg,79
9
- polarsteps_data_parser-0.1.1.dist-info/licenses/LICENSE,sha256=hxqP9qEfnLOSMQQMvUWQ4g-GOG6pny7O0_9AExvE-xU,1072
10
- polarsteps_data_parser-0.1.1.dist-info/RECORD,,
6
+ polarsteps_data_parser-0.1.2.dist-info/METADATA,sha256=1nb1Q7pNYeFNibOYMGNVXGeuuGa_RXPQ8Cgzok7THzA,3130
7
+ polarsteps_data_parser-0.1.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
8
+ polarsteps_data_parser-0.1.2.dist-info/entry_points.txt,sha256=UyGRCnpI13JtHPVilcSVgUSDNEYyv8-EQWgiJm-_ABg,79
9
+ polarsteps_data_parser-0.1.2.dist-info/licenses/LICENSE,sha256=hxqP9qEfnLOSMQQMvUWQ4g-GOG6pny7O0_9AExvE-xU,1072
10
+ polarsteps_data_parser-0.1.2.dist-info/RECORD,,