ics-query 0.2.0a0__tar.gz → 0.3.0b0__tar.gz

{ics_query-0.2.0a0 → ics_query-0.3.0b0}/.github/ISSUE_TEMPLATE/bug_report.md

@@ -27,15 +27,9 @@ assignees: ''
 
 **Version:**
 <!-- Which Version do you use? -->
-v0.0.1
 
-<!-- Sometimes, the problems are in other packages. You can provide an overview
-     by running this command and passing the output:
-
-     pip list
--->
 ```shell
-pip list
+$ ics-query --version
 ```
 
 ## Additional context
@@ -45,5 +39,5 @@ pip list
 <!-- If possible, suggest a way of solving this or just let this text down there remain as it is. -->
 
 - [ ] add an ICS file in `ics_query/tests/runs/calendars`
-- [ ] add a test in `ics_query/tests/runs directory`
+- [ ] add a test in `ics_query/tests/runs`
 - [ ] fix the bug and ensure the test code passes

{ics_query-0.2.0a0 → ics_query-0.3.0b0}/PKG-INFO

@@ -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 → ics_query-0.3.0b0}/README.md

@@ -62,15 +62,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:
 
@@ -79,13 +97,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:
@@ -95,100 +131,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
 
@@ -266,6 +332,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
@@ -289,3 +364,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 → ics_query-0.3.0b0}/ics_query/__init__.py

@@ -1,11 +1,12 @@
-from .cli import main
+from .cli import cli, main
 from .version import __version__, __version_tuple__, version, version_tuple
 
 __all__ = [
-    "main",
+    "cli",
     "app",
     "__version__",
     "version",
     "__version_tuple__",
     "version_tuple",
+    "main",
 ]

{ics_query-0.2.0a0 → ics_query-0.3.0b0}/ics_query/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.2.0a0'
-__version_tuple__ = version_tuple = (0, 2, 0)
+__version__ = version = '0.3.0b0'
+__version_tuple__ = version_tuple = (0, 3, 0)