ics-query 0.2.0a0__py3-none-any.whl → 0.3.0b0__py3-none-any.whl

{ics_query-0.2.0a0.dist-info → ics_query-0.3.0b0.dist-info}/METADATA

@@ -1,10 +1,10 @@
 Metadata-Version: 2.3
 Name: ics-query
-Version: 0.2.0a0
+Version: 0.3.0b0
 Summary: Find out what happens in ICS calendar files - query and filter RFC 5545 compatible .ics files for events, journals, TODOs and more.
 Project-URL: Homepage, https://github.com/niccokunzmann/ics-query/
 Project-URL: Repository, https://github.com/niccokunzmann/ics-query/
-Project-URL: source_archive, https://github.com/niccokunzmann/ics-query/archive/c7eeb503fae7da069308a27a37232be96851c3e5.zip
+Project-URL: source_archive, https://github.com/niccokunzmann/ics-query/archive/8a23bc5bc6e89064a99de1e57afdcd94c180181c.zip
 Project-URL: Issues, https://github.com/niccokunzmann/ics-query/issues
 Project-URL: Documentation, https://github.com/niccokunzmann/ics-query/
 Project-URL: Changelog, https://github.com/niccokunzmann/ics-query/#changelog
@@ -686,7 +686,7 @@ License:                     GNU GENERAL PUBLIC LICENSE
         <https://www.gnu.org/licenses/why-not-lgpl.html>.
 License-File: LICENSE
 Keywords: calendar,command line,icalendar,ics,rfc5545,scheduling
-Classifier: Development Status :: 3 - Alpha
+Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
 Classifier: Operating System :: OS Independent
@@ -699,6 +699,7 @@ Requires-Python: >=3.9
 Requires-Dist: click
 Requires-Dist: icalendar
 Requires-Dist: recurring-ical-events<4,>=3.2.0
+Requires-Dist: x-wr-timezone
 Provides-Extra: test
 Requires-Dist: pytest; extra == 'test'
 Description-Content-Type: text/markdown
@@ -767,15 +768,33 @@ BEGIN:VEVENT
 ...
 ```
 
+#### Piping calendars
+
+You can pipe one or more calendars into the input.
+
+```shell
+cat calendar.ics | ics-query first -
+```
+
 ### Events at Certain Times
 
 You can query which events happen at certain times:
 
 ```shell
-ics-query at <date-time> calendar.ics -
+ics-query at TIME calendar.ics -
 ```
 
-`<date-time>` can be built up: It can be a year, a month, a day, an hour, a minute or a second.
+The format of TIME:
+
+| TIME | description |
+| ------- | ----------- |
+| `2019`    | the whole year 2019 |
+| `2019-08` | August 2019 |
+| `2019-08-12` | 12th of August 2019 |
+| `2019-08-12T17` | 17:00-18:00 at the 12th of August 2019 |
+| `2019-08-12T17:20` | 17:20-17:21 at the 12th of August 2019 |
+| `2019-08-12T17:20:00` | 17:20 at the 12th of August 2019 |
+
 
 Please see the command documentation for more help:
 
@@ -784,13 +803,31 @@ ics-query at --help
 ics-query --help
 ```
 
+You can get all **events** that happen at a certain **day**.
+
+```shell
+ics-query at --components VEVENT 2029-12-24 calendar.ics
+```
+
+You can get all **events** that happen **today**.
+
+```shell
+ics-query at --components VEVENT `date +%Y-%m-%d` calendar.ics
+```
+
+You can get all **TODO**s that happen at in certain **month**.
+
+```shell
+ics-query at --components VTODO 2029-12-24 calendar.ics
+```
+
 ### Events within a Time Span
 
 You can query which events happen between certain times:
 
 ```shell
-ics-query between <start> <end> calendar.ics -
-ics-query between <start> <duration> calendar.ics -
+ics-query between START END calendar.ics -
+ics-query between START DURATION calendar.ics -
 ```
 
 Please see the command documentation for more help:
@@ -800,100 +837,130 @@ ics-query between --help
 ics-query --help
 ```
 
+The format of START and END with examples:
+
+| START or END | Description |
+| ------- | ----------- |
+| `2019`    | the whole year 2019 |
+| `2019-08` | August 2019 |
+| `2019-08-12` | 12th of August 2019 |
+| `2019-08-12T17` | 17:00-18:00 at the 12th of August 2019 |
+| `2019-08-12T17:20` | 17:20-17:21 at the 12th of August 2019 |
+| `2019-08-12T17:20:00` | 17:20 at the 12th of August 2019 |
+
+Instead of an absolute time, you can specify a duration after the START.
+The `+` is optional.
+
+| DURATION | Description |
+| ------- | ----------- |
+| `+1d`   | one more day |
+| `+1h`   | one more hour |
+| `+1m`   | one more minute |
+| `+1s`   | one more second |
+| `+3600s`   | one more hour or 3600 seconds |
+| `+5d10h`   | five more days and 10 more hours |
+
 ### Time Span Examples
 
-This example returns the events within the next week:
+This example returns the occurrences within the **next week**:
 
 ```shell
 ics-query between `date +%Y%m%d` +7d calendar.ics -
 ```
 
-This example saves the events from the 1st of May 2024 to the 10th of June in
+This example saves the **events** from the **1st of May 2024 to the 10th of June** in
 events.ics:
 
 ```shell
-ics-query between 2024-5-1 2024-6-10 calendar.ics events.ics
+ics-query between --component VEVENT 2024-5-1 2024-6-10 calendar.ics events.ics
 ```
 
-In this example, you can check what is happening on New Years Eve 2025 around
+In this example, you can check what is happening on **New Years Eve 2025** around
 midnight:
 
 ```shell
 ics-query between 2025-12-31T21:00 +6h calendar.ics events.ics
 ```
 
-## Vision
-
-This section shows where we would like to get to.
-
-### `ics-query at` - occurrences at certain times
+### `ics-query all` - the whole calendar
 
-You can get all **events** that happen at a certain **day**.
+You can get everything that is happening in a calendar but that can be a lot!
 
 ```shell
-ics-query --components VEVENT at 2029-12-24 calendar.ics
+ics-query all calendar.ics
 ```
 
-You can get all **events** that happen **today**.
+### Filtering Components
 
-```shell
-ics-query --components VEVENT at `date +%Y-%m-%d` calendar.ics
-```
+We support different component types: VEVENT, VJOURNAL and VTODO.
+By default, we include all types in the result.
 
-You can get all **TODO**s that happen at in certain **month**.
+You can specify which components you would like to get using the
+`--component` or `-c` parameter.
 
 ```shell
-ics-query --components VTODO at 2029-12-24 calendar.ics
+-c VEVENT   # only events
+-c VTODO    # only TODOs
+-c VJOURNAL # only journal entries
+-c VEVENT -v VTODO # only events and journal entries
 ```
 
-### `ics-query at` - time ranges
+This example returns the first event of a calendar.
 
-### `ics-query --output=count` - count occurrences
+```shell
+ics-query first -c VEVENT calendar.ics -
+```
 
-### `ics-query --output=ics` - use ics as output (default)
+This is also available as `ICS_QUERY_COMPONENT` variable.
 
-### `ics-query --select-index` - reduce output size
+```shell
+export ICS_QUERY_COMPONENT=VEVENT
+# from now on, you will get only events
+ics-query first calendar.ics
+```
 
-Examples: `0,2,4` `0-10`
+### Timezones
 
-### `ics-query all` - the whole calendar
+You can set the timezone of the query, otherwise the event's local timezone is used and you
+might miss events in your own timezone.
 
-### `ics-query between` - time ranges
+The first event at New Year 2000 in the **event's local time**:
 
 ```shell
-ics-query between dt dt
-ics-query between dt duration
+ics-query at 2000-01-01 calendar.ics
 ```
 
-### `ics-query --select-component` - filter for components
+The first event at New Year 2000 in **your local time**:
 
-### `ics-query --select-uid` - filter by uid
+```shell
+ics-query at --tz=localtime 2000-01-01 calendar.ics
+```
 
-## How to edit an event
+The first event at New Year 2000 in **UTC**:
 
-To edit a component like an event, you can append it to the calendar and increase the sequence number.
+```shell
+ics-query at --tz=UTC 2000-01-01 calendar.ics
+```
 
-Example:
+The first event at New Year 2000 in **Berlin time**:
 
-1. get the first event `--select-index=0` TODO: recurring-ical-events: set recurrence-id, sequence number
-2. change the summary
-3. increase sequence number
-4. add the event to the end of the calendar file
-5. show that the occurrence has changed
+```shell
+ics-query at --tz=Europe/Berlin 2000-01-01 calendar.ics
+```
 
-## Piping calendars
+You can also use the `ICS_QUERY_TZ` variable.
 
 ```shell
-cat calendar.ics | ics-query --output=count --filter-component=VEVENT all > calendar-event-count.int
+export ICS_QUERY_TZ=localtime
+# from now on, we use your local time
+ics-query at 2000-01-01 calendar.ics
 ```
 
-## Notifications
+For all avaiable timezones see:
 
-Examples:
-
-- There are x todos in the next hour
-- There are x events today
-- Please write a journal entry!
+```shell
+ics-query --available-timezones
+```
 
 ## Version Fixing
 
@@ -971,6 +1038,15 @@ To release new versions,
 
 ## Changelog
 
+- v0.3.0b
+
+  - Add `--tz` timezone parameter
+  - Add `ics-query all` to get all occurrences
+
+- v0.2.1a
+
+  - Add `--component` to filter component types VEVENT, VJOURNAL and VTODO
+
 - v0.2.0a
 
   - Add `ics-query first <calendar> <output>` for earliest occurrences
@@ -994,3 +1070,35 @@ To release new versions,
 ## Related Work
 
 - [icalBuddy](https://hasseg.org/icalBuddy/)
+
+## Vision
+
+This section shows where we would like to get to.
+
+### `ics-query --select-index` - reduce output size
+
+Examples: `0,2,4` `0-10`
+
+
+### `ics-query --select-uid` - filter by uid
+
+### How to edit an event
+
+To edit a component like an event, you can append it to the calendar and increase the sequence number.
+
+Example:
+
+1. get the event `--select-index=0`
+2. change the summary
+3. increase sequence number
+4. add the event to the end of the calendar file
+5. show that the occurrence has changed
+
+
+### Notifications
+
+Examples:
+
+- There are x todos in the next hour
+- There are x events today
+- Please write a journal entry!

{ics_query-0.2.0a0.dist-info → ics_query-0.3.0b0.dist-info}/RECORD

@@ -1,30 +1,43 @@
-ics_query/__init__.py,sha256=YxyZzqxwfA77sBVFjUyUj3_fvR2gL3bs0pkE93prRFY,216
+ics_query/__init__.py,sha256=CN48ECsXCq2OzZ4Waj1_0j4oTxUUjH5NFfnaYYma7NY,232
 ics_query/__main__.py,sha256=E6Gls0DNz8GQK2K-kOUIx8cYhgANW_CH54VKrfCfs14,52
-ics_query/_version.py,sha256=uRzu9Kl96sLvzy9j33tEqvTz_UjQeHK61WNjh5la-qA,413
-ics_query/cli.py,sha256=230EXFOKdZYXrJhRlpuqKle30H6DxrVhNTqU5uWF1uk,12372
+ics_query/_version.py,sha256=B-4CcxJgND-NHNJ8i5tcgV-dwWIrZ-oQkFxWpPZ9MR8,413
+ics_query/cli.py,sha256=xLZSIrszPAWAseLtapwKxYQ5pUbiKDBrTulu0zErIDc,18175
 ics_query/parse.py,sha256=mq6d1m7ITiEqD901nu54yvnYfY4U71J8_l5c9JdlPZ8,1730
-ics_query/version.py,sha256=LgqmHh_dcmWi9HMxfWJ8OhfmbzWsBTq3h08jIE18pYM,468
+ics_query/query.py,sha256=Y8e_sZygp4bkBznqH20duw-QVWmV_TARzaMANWcwHTg,1717
+ics_query/version.py,sha256=6dSmmmajuyZaNKL8nJBk6jUaebuZaNKO_dsQerNrbo0,828
 ics_query/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ics_query/tests/conftest.py,sha256=MGwKXod7sFfepXK0mtvKkR8SaIiI1SZNW_rAhz6aSA0,2258
-ics_query/tests/test_command_line.py,sha256=-XnpYWETEVEc1dJ5_dpd8dqBoMQFz1CyGaSoe_ETq5o,488
+ics_query/tests/test_command_line.py,sha256=6JYWqMqm0CmBfBQVBXzTXlbnNoY0-ju4cKNk541jSnI,902
 ics_query/tests/test_parse_date.py,sha256=vVOj5bBvYel3euKmuBMy2v-uhpMDnC03OVcjyahhXPE,2100
 ics_query/tests/test_parse_timedelta.py,sha256=wsAdfyagfndkZXX-KfAVDf4Ui2o2hcSu_yoUeyKuSuo,784
+ics_query/tests/runs/all --tz Singapore one-event.ics -.run,sha256=sWF9T4kKzhnZYrgidUX5sgdJ5q95q1gp9vd8X65bIdk,218
+ics_query/tests/runs/all three-events.ics -.run,sha256=gdcQ-LKaM0Bpre06txuoTTk2WYIh4Qe2-v0weO2Ckkc,768
 ics_query/tests/runs/at 2019-03-04 multiple-calendars.ics -.run,sha256=Cyeg9DMK6BibiCwkM8nW0ZtULUYSZFIgDvKRlSo_jTw,482
 ics_query/tests/runs/at 2019-03-04 one-event-twice.ics -.run,sha256=hc-0yJhWpnSVzPNB_0_tJfR6dskNMm9xdbHeAhsX1zI,452
 ics_query/tests/runs/at 2019-03-04 one-event.ics -.run,sha256=GVVmVpqzFjQLw2_RuhxnVTpCnwflNqeWbkFZ6u5WXxA,226
 ics_query/tests/runs/at 2019-03-07 multiple-calendars.ics -.run,sha256=ZlLXxPMIai7vvmQTL4NyXJwdCQzoU1scEn_FpjmkkUA,256
+ics_query/tests/runs/at 2024-08-20 Berlin-Los-Angeles.ics -.run,sha256=KzQaFp65wntWfEu4fQwr3iH1kE-ooEmslA4UeA9-gkc,643
 ics_query/tests/runs/between 20240823 4d recurring-work-events.ics -.run,sha256=2_sM7CkSW4SDk6wbwyLURZ8WZm2rT0hgmx1k7O07T3M,574
+ics_query/tests/runs/first -c VJOURNAL -c VEVENT one-event.ics -.run,sha256=GVVmVpqzFjQLw2_RuhxnVTpCnwflNqeWbkFZ6u5WXxA,226
+ics_query/tests/runs/first -c VJOURNAL one-event.ics -.run,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ics_query/tests/runs/first -c VJOURNAL simple-journal.ics -.run,sha256=Av_N2nsE2sfku6owvJwguQ53699C-GTHV5tWS8j5mZ4,370
+ics_query/tests/runs/first -c VTODO -c VJOURNAL simple-todo.ics -.run,sha256=-mcQWZIxMcIdSMOeHpdzAWDLXseGULNHOoGhy6ca8J0,224
+ics_query/tests/runs/first -c VTODO simple-todo.ics -.run,sha256=-mcQWZIxMcIdSMOeHpdzAWDLXseGULNHOoGhy6ca8J0,224
 ics_query/tests/runs/first empty-calendar.ics -.run,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ics_query/tests/runs/first empty-file.ics -.run,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ics_query/tests/runs/first recurring-work-events.ics -.run,sha256=-mGNYgI4vBSkBMMJ0WCYdkg97JpnOJ64rlaqdSKCi2Y,287
+ics_query/tests/runs/calendars/Berlin-Los-Angeles.ics,sha256=_FFRUurDU_q7G8d8lSvfbCy3y1XvujaclLXei6GrW5U,9107
 ics_query/tests/runs/calendars/empty-calendar.ics,sha256=78162P3KYUj6Qhbdnjsm3E84jv--_--p5U0h_jovrpw,153
 ics_query/tests/runs/calendars/empty-file.ics,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ics_query/tests/runs/calendars/multiple-calendars.ics,sha256=lS1Q9eSPpzLs2TRDKUiwF9HmpnJMw8xqjLudA0-KtY4,1516
 ics_query/tests/runs/calendars/one-event-twice.ics,sha256=GZ5wE-U4kjO91N2nIaLsYZpSOLvQTjkoLPI6saMocOM,1450
 ics_query/tests/runs/calendars/one-event.ics,sha256=-uwohttEzg-jsTETNb6tQ5dO9PE3DXzlicwRiXJs1KQ,725
 ics_query/tests/runs/calendars/recurring-work-events.ics,sha256=4ASS_-xZl2pVv1kZ7nDOU9jpkmbo4zJC2KEAgHtpsNU,5115
-ics_query-0.2.0a0.dist-info/METADATA,sha256=XC_fP8LNXU151JQdT-irzijqZO2nKCiFsCqwqGhif1I,49120
-ics_query-0.2.0a0.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-ics_query-0.2.0a0.dist-info/entry_points.txt,sha256=Jq_39vCKVOkNZjL7Wngf_04V_n_QRszLgLT2CbJKiH4,49
-ics_query-0.2.0a0.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-ics_query-0.2.0a0.dist-info/RECORD,,
+ics_query/tests/runs/calendars/simple-journal.ics,sha256=U6_YMQM6EHwPDaszWgJDo-pR4WIqbJx8CRlHg4iu9zA,457
+ics_query/tests/runs/calendars/simple-todo.ics,sha256=l9uHQD4eyiCE8STvd2tj5lAVaBrqUtpF_M8Pv6yf1es,327
+ics_query/tests/runs/calendars/three-events.ics,sha256=YvPfthOzMCR0DQhGR6uj_1Bltgax3uA1ETlkI4JUI08,828
+ics_query-0.3.0b0.dist-info/METADATA,sha256=64fCboXNTqb7V0KEzrvbSU1s7axOn5PJn-r4u3xtKfw,51589
+ics_query-0.3.0b0.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+ics_query-0.3.0b0.dist-info/entry_points.txt,sha256=Jq_39vCKVOkNZjL7Wngf_04V_n_QRszLgLT2CbJKiH4,49
+ics_query-0.3.0b0.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+ics_query-0.3.0b0.dist-info/RECORD,,