ics-query 0.1.dev8__tar.gz → 0.2.0a0__tar.gz

{ics_query-0.1.dev8 → ics_query-0.2.0a0}/.github/workflows/tests.yml

@@ -56,7 +56,7 @@ jobs:
     # see https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment
     environment:
       name: PyPI
-      url: https://pypi.org/project/open-web-calendar/
+      url: https://pypi.org/project/ics-query/
     # after using the environment, we need to make the secrets available
     # see https://docs.github.com/en/actions/security-guides/encrypted-secrets#example-using-bash
     env:
@@ -72,18 +72,6 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         pip install --upgrade wheel twine build
-#    - name: Check the tag
-#      run: |
-#        PACKAGE_VERSION=`python setup.py --version`
-#        TAG_NAME=v$PACKAGE_VERSION
-#        echo "Package version $PACKAGE_VERSION with possible tag name $TAG_NAME on $GITHUB_REF_NAME"
-#        # test that the tag represents the version
-#        # see https://docs.gitlab.com/ee/ci/variables/predefined_variables.html
-#        # see https://docs.github.com/en/actions/learn-github-actions/environment-variables
-#        if [ "$TAG_NAME" != "$GITHUB_REF_NAME" ]; then
-#          echo "ERROR: This tag is for the wrong version. Got \"$GITHUB_REF_NAME\" expected \"$TAG_NAME\"."
-#          exit 1
-#        fi
     - name: remove old files
       run: rm -rf dist/*
     - name: build distribution files
@@ -113,7 +101,6 @@ jobs:
     if: ${{ startsWith(github.ref, 'refs/tags/v') }}
     needs:
       - run-tests
-      - dockerhub
       - deploy-tag-to-pypi
     runs-on: ubuntu-latest
     steps:
@@ -122,5 +109,5 @@ jobs:
         uses: ncipollo/release-action@v1
         with:
           allowUpdates: true
-          body: "For a list of changes, please refer to the [Changelog](https://open-web-calendar.quelltext.eu/changelog/)."
+          body: "For a list of changes, please refer to the [Changelog](https://github.com/niccokunzmann/ics-query#changelog)."
           generateReleaseNotes: false

{ics_query-0.1.dev8 → ics_query-0.2.0a0}/.gitignore

@@ -160,3 +160,4 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
+ics_query/_version.py

{ics_query-0.1.dev8 → ics_query-0.2.0a0}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.3
 Name: ics-query
-Version: 0.1.dev8
-Summary: Find out what happens in ICS calendar files - query and filter RFC 5545 compatible `.ics` files for events, journals, TODOs and more.
+Version: 0.2.0a0
+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/3f1c4acd60666416eb899f7a0c07a05999d443c3.zip
+Project-URL: source_archive, https://github.com/niccokunzmann/ics-query/archive/c7eeb503fae7da069308a27a37232be96851c3e5.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
@@ -690,12 +690,15 @@ Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
 Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Office/Business :: Scheduling
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 Requires-Dist: click
 Requires-Dist: icalendar
-Requires-Dist: recurring-ical-events
+Requires-Dist: recurring-ical-events<4,>=3.2.0
 Provides-Extra: test
 Requires-Dist: pytest; extra == 'test'
 Description-Content-Type: text/markdown
@@ -713,7 +716,117 @@ You can install this package from the [PyPI](https://pypi.org/project/ics-query/
 pip install ics-query
 ```
 
-## `ics-query at` - occurrences at certain times
+## Usage
+
+See how to use `ics-query`.
+
+### Examples
+
+You can easily get a calendar from the web and see what is on.
+In this example, we show which German National Holidays happen in August 2024:
+
+```shell
+$ wget -qO- 'https://www.calendarlabs.com/ical-calendar/ics/46/Germany_Holidays.ics' | ./ics-query at 2024-08 - -
+BEGIN:VEVENT
+SUMMARY:Assumption Day (BY\, SL)
+DTSTART;VALUE=DATE:20240815
+DTEND;VALUE=DATE:20240815
+DTSTAMP:20231013T092513Z
+UID:65290cf9326601697189113@calendarlabs.com
+SEQUENCE:0
+DESCRIPTION:Visit https://calendarlabs.com/holidays/us/the-assumption-of-m
+ ary.php to know more about Assumption Day (BY\, SL). \n\n Like us on Faceb
+ ook: http://fb.com/calendarlabs to get updates
+LOCATION:Germany
+STATUS:CONFIRMED
+TRANSP:TRANSPARENT
+END:VEVENT
+```
+
+In the following example, we query a calendar file and print the result.
+
+```shell
+$ ics-query at 2019-03-04 one-event.ics -
+BEGIN:VEVENT
+SUMMARY:test1
+DTSTART;TZID=Europe/Berlin:20190304T080000
+DTEND;TZID=Europe/Berlin:20190304T083000
+DTSTAMP:20190303T111937
+UID:UYDQSG9TH4DE0WM3QFL2J
+CREATED:20190303T111937
+LAST-MODIFIED:20190303T111937
+END:VEVENT
+```
+
+We can concatenate calendars and pipe them into `ics-query`.
+In the example below, we get all events that happen right now in two calendars.
+
+```shell
+$ cat calendar1.ics calendar2.ics | ics-query at `date +%Y%m%d%H%M%S` - -
+BEGIN:VEVENT
+...
+```
+
+### Events at Certain Times
+
+You can query which events happen at certain times:
+
+```shell
+ics-query at <date-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.
+
+Please see the command documentation for more help:
+
+```shell
+ics-query at --help
+ics-query --help
+```
+
+### 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 -
+```
+
+Please see the command documentation for more help:
+
+```shell
+ics-query between --help
+ics-query --help
+```
+
+### Time Span Examples
+
+This example returns the events 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
+events.ics:
+
+```shell
+ics-query between 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
+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
 
 You can get all **events** that happen at a certain **day**.
 
@@ -733,33 +846,28 @@ You can get all **TODO**s that happen at in certain **month**.
 ics-query --components VTODO at 2029-12-24 calendar.ics
 ```
 
-## `ics-query at` - time ranges
-
-
-## `ics-query --output=count` - count occurrences
-
+### `ics-query at` - time ranges
 
-## `ics-query --output=ics` - use ics as output (default)
+### `ics-query --output=count` - count occurrences
 
+### `ics-query --output=ics` - use ics as output (default)
 
-## `ics-query --select-index` - reduce output size
+### `ics-query --select-index` - reduce output size
 
 Examples: `0,2,4` `0-10`
 
-## `ics-query all` - the whole calendar
+### `ics-query all` - the whole calendar
 
-## `ics-query between` - time ranges
+### `ics-query between` - time ranges
 
 ```shell
 ics-query between dt dt
 ics-query between dt duration
 ```
 
-## `ics-query --select-component` - filter for components
-
-
-## `ics-query --select-uid` - filter by uid
+### `ics-query --select-component` - filter for components
 
+### `ics-query --select-uid` - filter by uid
 
 ## How to edit an event
 
@@ -787,8 +895,102 @@ Examples:
 - There are x events today
 - Please write a journal entry!
 
+## Version Fixing
+
+If you use this library in your code, you may want to make sure that
+updates can be received but they do not break your code.
+The version numbers are handeled this way: `a.b.c` example: `0.1.12`
+
+- `c` is changed for each minor bug fix.
+- `b` is changed whenever new features are added.
+- `a` is changed when the interface or major assumptions change that may break your code.
+
+So, I recommend to version-fix this library to stay with the same `a`
+while `b` and `c` can change.
+
+## Development
+
+This section should set you up for development.
+
+### Testing
+
+This project's development is driven by tests.
+Tests assure a consistent interface and less knowledge lost over time.
+If you like to change the code, tests help that nothing breaks in the future.
+They are required in that sense.
+Example code and ics files can be transferred into tests and speed up fixing bugs.
+
+You can view the tests in the [test folder](https://github.com/niccokunzmann/ics-query/tree/main/ics_query/tests)
+If you have a calendar ICS file for which this library does not
+generate the desired output, you can add it to the ``test/calendars``
+folder and write tests for what you expect.
+If you like, [open an issue](https://github.com/niccokunzmann/ics-query/issues) first, e.g. to discuss the changes and
+how to go about it.
+
+To run the tests, we use `tox`.
+`tox` tests all different Python versions which we want to  be compatible to.
+
+```shell
+pip3 install tox
+```
+
+To run all the tests:
+
+```shell
+tox
+```
+
+To run the tests in a specific Python version:
+
+```shell
+tox -e py39
+```
+
+We use ``ruff`` to format the code.
+Run this to format the code and show problems:
+
+```shell
+tox -e ruff
+```
+
+### New Release
+
+To release new versions,
+
+1. edit the Changelog Section
+2. create a commit and push it
+3. wait for [GitHub Actions](https://github.com/niccokunzmann/ics-query/actions) to finish the build
+4. create a tag and push it
+
+    ```shell
+    git tag v0.1.0a
+    git push origin v0.1.0a
+    ```
+
+5. Notify the issues about their release
+
 ## Changelog
 
+- v0.2.0a
+
+  - Add `ics-query first <calendar> <output>` for earliest occurrences
+  - Add `ics-query between <span_start> <span_stop> <calendar> <output>` to query time ranges
+
+- v0.1.1a
+
+  - Add `--version`
+  - Add `ics-query at <date> <calendar> <output>`
+  - Add support for multiple calendars in one input
+
+- v0.1.0a
+
+  - Update Python version compatibility
+  - Add development documentation
+
 - v0.0.1a
 
   - first version
+
+## Related Work
+
+- [icalBuddy](https://hasseg.org/icalBuddy/)

ics_query-0.2.0a0/README.md

@@ -0,0 +1,291 @@
+# ics-query
+
+<!-- Change description also in pyproject.toml -->
+Find out what happens in ICS calendar files - query and filter RFC 5545 compatible `.ics` files for events, journals, TODOs and more.
+
+## Installation
+
+You can install this package from the [PyPI](https://pypi.org/project/ics-query/).
+
+```shell
+pip install ics-query
+```
+
+## Usage
+
+See how to use `ics-query`.
+
+### Examples
+
+You can easily get a calendar from the web and see what is on.
+In this example, we show which German National Holidays happen in August 2024:
+
+```shell
+$ wget -qO- 'https://www.calendarlabs.com/ical-calendar/ics/46/Germany_Holidays.ics' | ./ics-query at 2024-08 - -
+BEGIN:VEVENT
+SUMMARY:Assumption Day (BY\, SL)
+DTSTART;VALUE=DATE:20240815
+DTEND;VALUE=DATE:20240815
+DTSTAMP:20231013T092513Z
+UID:65290cf9326601697189113@calendarlabs.com
+SEQUENCE:0
+DESCRIPTION:Visit https://calendarlabs.com/holidays/us/the-assumption-of-m
+ ary.php to know more about Assumption Day (BY\, SL). \n\n Like us on Faceb
+ ook: http://fb.com/calendarlabs to get updates
+LOCATION:Germany
+STATUS:CONFIRMED
+TRANSP:TRANSPARENT
+END:VEVENT
+```
+
+In the following example, we query a calendar file and print the result.
+
+```shell
+$ ics-query at 2019-03-04 one-event.ics -
+BEGIN:VEVENT
+SUMMARY:test1
+DTSTART;TZID=Europe/Berlin:20190304T080000
+DTEND;TZID=Europe/Berlin:20190304T083000
+DTSTAMP:20190303T111937
+UID:UYDQSG9TH4DE0WM3QFL2J
+CREATED:20190303T111937
+LAST-MODIFIED:20190303T111937
+END:VEVENT
+```
+
+We can concatenate calendars and pipe them into `ics-query`.
+In the example below, we get all events that happen right now in two calendars.
+
+```shell
+$ cat calendar1.ics calendar2.ics | ics-query at `date +%Y%m%d%H%M%S` - -
+BEGIN:VEVENT
+...
+```
+
+### Events at Certain Times
+
+You can query which events happen at certain times:
+
+```shell
+ics-query at <date-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.
+
+Please see the command documentation for more help:
+
+```shell
+ics-query at --help
+ics-query --help
+```
+
+### 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 -
+```
+
+Please see the command documentation for more help:
+
+```shell
+ics-query between --help
+ics-query --help
+```
+
+### Time Span Examples
+
+This example returns the events 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
+events.ics:
+
+```shell
+ics-query between 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
+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
+
+You can get all **events** that happen at a certain **day**.
+
+```shell
+ics-query --components VEVENT at 2029-12-24 calendar.ics
+```
+
+You can get all **events** that happen **today**.
+
+```shell
+ics-query --components VEVENT at `date +%Y-%m-%d` calendar.ics
+```
+
+You can get all **TODO**s that happen at in certain **month**.
+
+```shell
+ics-query --components VTODO at 2029-12-24 calendar.ics
+```
+
+### `ics-query at` - time ranges
+
+### `ics-query --output=count` - count occurrences
+
+### `ics-query --output=ics` - use ics as output (default)
+
+### `ics-query --select-index` - reduce output size
+
+Examples: `0,2,4` `0-10`
+
+### `ics-query all` - the whole calendar
+
+### `ics-query between` - time ranges
+
+```shell
+ics-query between dt dt
+ics-query between dt duration
+```
+
+### `ics-query --select-component` - filter for components
+
+### `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 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
+
+## Piping calendars
+
+```shell
+cat calendar.ics | ics-query --output=count --filter-component=VEVENT all > calendar-event-count.int
+```
+
+## Notifications
+
+Examples:
+
+- There are x todos in the next hour
+- There are x events today
+- Please write a journal entry!
+
+## Version Fixing
+
+If you use this library in your code, you may want to make sure that
+updates can be received but they do not break your code.
+The version numbers are handeled this way: `a.b.c` example: `0.1.12`
+
+- `c` is changed for each minor bug fix.
+- `b` is changed whenever new features are added.
+- `a` is changed when the interface or major assumptions change that may break your code.
+
+So, I recommend to version-fix this library to stay with the same `a`
+while `b` and `c` can change.
+
+## Development
+
+This section should set you up for development.
+
+### Testing
+
+This project's development is driven by tests.
+Tests assure a consistent interface and less knowledge lost over time.
+If you like to change the code, tests help that nothing breaks in the future.
+They are required in that sense.
+Example code and ics files can be transferred into tests and speed up fixing bugs.
+
+You can view the tests in the [test folder](https://github.com/niccokunzmann/ics-query/tree/main/ics_query/tests)
+If you have a calendar ICS file for which this library does not
+generate the desired output, you can add it to the ``test/calendars``
+folder and write tests for what you expect.
+If you like, [open an issue](https://github.com/niccokunzmann/ics-query/issues) first, e.g. to discuss the changes and
+how to go about it.
+
+To run the tests, we use `tox`.
+`tox` tests all different Python versions which we want to  be compatible to.
+
+```shell
+pip3 install tox
+```
+
+To run all the tests:
+
+```shell
+tox
+```
+
+To run the tests in a specific Python version:
+
+```shell
+tox -e py39
+```
+
+We use ``ruff`` to format the code.
+Run this to format the code and show problems:
+
+```shell
+tox -e ruff
+```
+
+### New Release
+
+To release new versions,
+
+1. edit the Changelog Section
+2. create a commit and push it
+3. wait for [GitHub Actions](https://github.com/niccokunzmann/ics-query/actions) to finish the build
+4. create a tag and push it
+
+    ```shell
+    git tag v0.1.0a
+    git push origin v0.1.0a
+    ```
+
+5. Notify the issues about their release
+
+## Changelog
+
+- v0.2.0a
+
+  - Add `ics-query first <calendar> <output>` for earliest occurrences
+  - Add `ics-query between <span_start> <span_stop> <calendar> <output>` to query time ranges
+
+- v0.1.1a
+
+  - Add `--version`
+  - Add `ics-query at <date> <calendar> <output>`
+  - Add support for multiple calendars in one input
+
+- v0.1.0a
+
+  - Update Python version compatibility
+  - Add development documentation
+
+- v0.0.1a
+
+  - first version
+
+## Related Work
+
+- [icalBuddy](https://hasseg.org/icalBuddy/)

ics_query-0.2.0a0/ics-query

@@ -0,0 +1 @@
+.venv/bin/ics-query

{ics_query-0.1.dev8 → ics_query-0.2.0a0}/ics_query/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.1.dev8'
-__version_tuple__ = version_tuple = (0, 1, 'dev8')
+__version__ = version = '0.2.0a0'
+__version_tuple__ = version_tuple = (0, 2, 0)