Skip to content

Commit a8cb02c

Browse files
committed
Updated README
1 parent 3fe5ddc commit a8cb02c

File tree

1 file changed

+14
-24
lines changed

1 file changed

+14
-24
lines changed

README.md

Lines changed: 14 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -8,44 +8,34 @@ Tool designed to parse and extract data from the travel tracking app [Polarsteps
88
## Getting started
99

1010
### Installation
11-
To set up the project, ensure you have Python 3.11+ installed. Follow these steps:
12-
13-
Clone the repository:
14-
15-
```shell
16-
git clone https://github.com/niekvleeuwen/polarsteps-data-parser.git
17-
cd polarsteps-trip-analyzer
18-
```
19-
20-
Ensure poetry is available, e.g. on Ubuntu/Debian you can run the following:
11+
To set up the project, ensure you have Python 3.11+ installed.
2112

13+
Install from PyPI using pip:
2214
```shell
23-
apt-get install python3 poetry
15+
pip install polarsteps-data-parser
2416
```
2517

26-
Install dependencies using Poetry:
18+
### Usage
19+
To get the following output, run `polarsteps-data-parser --help`.
2720

2821
```shell
29-
poetry install
30-
```
31-
32-
Then enter the created virtual environment:
22+
Usage: polarsteps-data-parser [OPTIONS] INPUT_FOLDER
3323

34-
```shell
35-
poetry shell
36-
```
24+
Parse the data from a Polarsteps trip export.
3725

38-
### Usage
39-
To run the project, use the following command:
26+
INPUT_FOLDER should contain the Polarsteps data export of one (!) trip. Make
27+
sure the folder contains a `trip.json` and `locations.json`.
4028

41-
```shell
42-
polarsteps-data-parser [OPTIONS]
29+
Options:
30+
--output TEXT Output PDF file name [default: Trip report.pdf]
31+
--enrich-with-comments Whether to enrich the trip with comments or not.
32+
--help Show this message and exit.
4333
```
4434

4535
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:
4636

4737
```shell
48-
polarsteps-data-parser --input-folder ./data/trip1 --enrich-comments
38+
polarsteps-data-parser ./data/trip1 --enrich-with-comments
4939
```
5040

5141
## Disclaimer

0 commit comments

Comments
 (0)