diff --git a/README.md b/README.md index f8d6958..452af90 100644 --- a/README.md +++ b/README.md @@ -58,6 +58,14 @@ $ python -m event_scrapper_srt --output-path output.json 2024-07-10 21:44:22,058 - INFO - Saved 16 events to `/home/tpwo/ws/event-scrapper-srt/output.json` ``` +### Output file structure + +Output file is [Newline Delimited JSON](https://github.com/ndjson/ndjson-spec) format which means. Each line has the following structure: + +```json +{"title": "Lindy Hop dla początkujacych | intensywne warsztaty", "description": "

Daj się zarazić swingowym bakcylem...", "place_name": "Studio Swing Revolution Trójmiasto", "place_address": "Łąkowa 35/38, Gdańsk", "online_locations": ["https://swingrevolution.pl/warsztaty-lindy-hop-od-podstaw/"], "start_datetime": 1722074400, "end_datetime": 1722085200, "multidate": 1, "tags": ["swing"], "image_url": "https://swingrevolution.pl/wp-content/uploads/2022/04/351150267_646835474155254_2037209978322475013_n.jpg"} +``` + ## Development ### Run unit tests and static checks diff --git a/event_scrapper_srt/main.py b/event_scrapper_srt/main.py index 72f0bb9..e8f3355 100644 --- a/event_scrapper_srt/main.py +++ b/event_scrapper_srt/main.py @@ -26,7 +26,7 @@ def main(argv: list[str] | None = None) -> int: parser.add_argument( '--output-path', default=f'output/{datetime.now().isoformat()}.json', - help='JSON with scrapped events is saved there (default: %(default)s)', + help='NDJSON with scrapped events is saved there (default: %(default)s)', ) args = parser.parse_args(argv)