ics-query 0.3.1b0__tar.gz → 0.3.3b0__tar.gz

{ics_query-0.3.1b0 → ics_query-0.3.3b0}/.github/workflows/tests.yml

@@ -14,14 +14,15 @@ jobs:
     strategy:
       matrix:
         config:
-        # [Python version, tox env]
-        - ["3.9",   "py39"]
-        - ["3.10",  "py310"]
-        - ["3.11",  "py311"]
-        - ["3.12",  "py312"]
-        - ["3.9",  "ruff"]
+        # [Python version, tox env, OS]
+        - ["3.9",   "py39", "ubuntu-latest"]
+        - ["3.10",  "py310", "ubuntu-latest"]
+        - ["3.11",  "py311", "ubuntu-latest"]
+        - ["3.12",  "py312", "ubuntu-latest"]
+        - ["3.9",  "ruff", "ubuntu-latest"]
+        - ["3.11",  "exe", "windows-latest"]
 
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.config[2] }}
     name: ${{ matrix.config[1] }}
     steps:
     - uses: actions/checkout@v4
@@ -29,14 +30,6 @@ jobs:
       uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.config[0] }}
-    - name: Pip cache
-      uses: actions/cache@v4
-      with:
-        path: ~/.cache/pip
-        key: ${{ runner.os }}-pip-${{ matrix.config[0] }}-${{ hashFiles('pyproject.toml', 'tox.ini') }}
-        restore-keys: |
-          ${{ runner.os }}-pip-${{ matrix.config[0] }}-
-          ${{ runner.os }}-pip-
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
@@ -44,7 +37,14 @@ jobs:
     - name: Test
       run: |
         tox -e ${{ matrix.config[1] }}
-
+    - uses: actions/upload-artifact@v4
+      with:
+        name: dist-${{ matrix.config[1] }}-${{ matrix.config[2] }}  # dist-exe-windows-latest
+        path: dist
+        if-no-files-found: ignore
+        retention-days: 1
+        compression-level: 0
+        
   deploy-tag-to-pypi:
     name: Publish Package on PyPI
     # only deploy on tags, see https://stackoverflow.com/a/58478262/1320237
@@ -95,6 +95,18 @@ jobs:
         twine check dist/*
         twine upload dist/*
           
+  # artifact-check:
+  #   name: artifact check
+  #   runs-on: ubuntu-latest
+  #   needs:
+  #     - run-tests
+  #   steps:
+  #   - uses: actions/download-artifact@v4
+  #     with:
+  #       pattern: dist-*
+  #       path: dist
+  #   - run: ls -R dist
+  
   github-release:
     name: "Publish GitHub Release"
     # only deploy on tags, see https://stackoverflow.com/a/58478262/1320237
@@ -105,9 +117,15 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+      - uses: actions/download-artifact@v4
+        with:
+          pattern: dist-*
+          path: dist
+      - run: ls -R dist
       - name: create release
         uses: ncipollo/release-action@v1
         with:
           allowUpdates: true
           body: "For a list of changes, please refer to the [Changelog](https://github.com/niccokunzmann/ics-query#changelog)."
-          generateReleaseNotes: false
+          generateReleaseNotes: false
+          artifacts: "dist/dist-exe-windows-latest/ics-query.exe"

{ics_query-0.3.1b0 → ics_query-0.3.3b0}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.3
 Name: ics-query
-Version: 0.3.1b0
+Version: 0.3.3b0
 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/985400ff5c4df0ea4ad62422ef5c5c5e98face07.zip
+Project-URL: source_archive, https://github.com/niccokunzmann/ics-query/archive/b25d84b7ea3a72f12c992e3702f8e082159fc71f.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
@@ -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: tzlocal
 Requires-Dist: x-wr-timezone
 Provides-Extra: test
 Requires-Dist: pytest; extra == 'test'
@@ -723,6 +724,8 @@ You can install this package from the [PyPI].
 pip install ics-query
 ```
 
+For **Windows**, you can download `ics-query.exe` from our [Releases].
+
 ## Support
 
 - Support using [GitHub Sponsors]
@@ -733,7 +736,20 @@ pip install ics-query
 We accept donations to sustain our work, once or regular.
 Consider donating money to open-source as everyone benefits.
 
+## Supported Features
+
+This library is based on
+
+- [recurring-ical-events]
+- [icalendar]
+- [x-wr-timezone]
 
+[recurring-ical-events]: https://pypi.org/project/recurring-ical-events/
+[icalendar]: https://pypi.org/project/icalendar/
+[x-wr-timezone]: https://pypi.org/project/x-wr-timezone/
+
+For a list of supported features and RFC compatibility,
+please refer to their documentation, too.
 
 ## Usage
 
@@ -741,6 +757,10 @@ Consider donating money to open-source as everyone benefits.
 accessible and easy.
 This section walks you though the different functionalities.
 
+```shell
+ics-query --help
+```
+
 ### Examples
 
 You can get a calendar from the web and see what is on.
@@ -922,7 +942,7 @@ You can specify which components you would like to get using the
 -c VEVENT   # only events
 -c VTODO    # only TODOs
 -c VJOURNAL # only journal entries
--c VEVENT -v VTODO # only events and journal entries
+-c VEVENT -c VTODO # only events and journal entries
 ```
 
 This example returns the first event of a calendar.
@@ -1071,6 +1091,16 @@ To release new versions,
 
 ## Changelog
 
+- v0.3.3b
+
+  - Update dependencies
+
+- v0.3.2b
+
+  - Fix that `--tz localtime` would use `localtime` as timezone name instead of the local timezone name.
+  - Fix tests on Windows
+  - Add Windows .exe build artifact
+
 - v0.3.1b
 
   - Add `--license` option
@@ -1148,3 +1178,4 @@ Examples:
 [Polar]: https://polar.sh/niccokunzmann/ics-query
 [GitHub Sponsors]: https://github.com/sponsors/niccokunzmann
 [thanks.dev]: https://thanks.dev
+[Releases]: https://github.com/niccokunzmann/ics-query/releases

{ics_query-0.3.1b0 → ics_query-0.3.3b0}/README.md

@@ -17,6 +17,8 @@ You can install this package from the [PyPI].
 pip install ics-query
 ```
 
+For **Windows**, you can download `ics-query.exe` from our [Releases].
+
 ## Support
 
 - Support using [GitHub Sponsors]
@@ -27,7 +29,20 @@ pip install ics-query
 We accept donations to sustain our work, once or regular.
 Consider donating money to open-source as everyone benefits.
 
+## Supported Features
+
+This library is based on
+
+- [recurring-ical-events]
+- [icalendar]
+- [x-wr-timezone]
 
+[recurring-ical-events]: https://pypi.org/project/recurring-ical-events/
+[icalendar]: https://pypi.org/project/icalendar/
+[x-wr-timezone]: https://pypi.org/project/x-wr-timezone/
+
+For a list of supported features and RFC compatibility,
+please refer to their documentation, too.
 
 ## Usage
 
@@ -35,6 +50,10 @@ Consider donating money to open-source as everyone benefits.
 accessible and easy.
 This section walks you though the different functionalities.
 
+```shell
+ics-query --help
+```
+
 ### Examples
 
 You can get a calendar from the web and see what is on.
@@ -216,7 +235,7 @@ You can specify which components you would like to get using the
 -c VEVENT   # only events
 -c VTODO    # only TODOs
 -c VJOURNAL # only journal entries
--c VEVENT -v VTODO # only events and journal entries
+-c VEVENT -c VTODO # only events and journal entries
 ```
 
 This example returns the first event of a calendar.
@@ -365,6 +384,16 @@ To release new versions,
 
 ## Changelog
 
+- v0.3.3b
+
+  - Update dependencies
+
+- v0.3.2b
+
+  - Fix that `--tz localtime` would use `localtime` as timezone name instead of the local timezone name.
+  - Fix tests on Windows
+  - Add Windows .exe build artifact
+
 - v0.3.1b
 
   - Add `--license` option
@@ -442,3 +471,4 @@ Examples:
 [Polar]: https://polar.sh/niccokunzmann/ics-query
 [GitHub Sponsors]: https://github.com/sponsors/niccokunzmann
 [thanks.dev]: https://thanks.dev
+[Releases]: https://github.com/niccokunzmann/ics-query/releases

ics_query-0.3.3b0/conftest.py

@@ -0,0 +1,15 @@
+"""Add options so they can be found by pytest.
+
+See https://stackoverflow.com/a/31526934/1320237
+"""
+
+import pytest
+
+
+def pytest_addoption(parser: pytest.Parser):
+    """Add options to pytest."""
+    # see https://stackoverflow.com/a/58425144
+    parser.addoption(
+        "--binary", action="store", default="ics-query", help="the ics-query command"
+    )
+    print("addoption")

ics_query-0.3.3b0/ics-query.cmd

@@ -0,0 +1,3 @@
+@ echo off
+
+.\.venv\Scripts\ics-query.exe %*

ics_query-0.3.3b0/ics-query.py

@@ -0,0 +1,5 @@
+"""ics-query script for pyinstaller."""
+
+from ics_query import main
+
+main()

{ics_query-0.3.1b0 → ics_query-0.3.3b0}/ics_query/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.3.1b0'
-__version_tuple__ = version_tuple = (0, 3, 1)
+__version__ = version = '0.3.3b0'
+__version_tuple__ = version_tuple = (0, 3, 3)

{ics_query-0.3.1b0 → ics_query-0.3.3b0}/ics_query/cli.py

@@ -25,6 +25,7 @@ import zoneinfo
 
 import click
 from icalendar.cal import Calendar, Component
+from tzlocal import get_localzone_name
 
 from . import parse
 from .query import Query
@@ -181,17 +182,18 @@ def opt_available_timezones(*param_decls: str, **kwargs: t.Any) -> t.Callable:
     """List available timezones.
 
     This is copied from the --help option.
+
+    Commonly used timezone names are added first.
     """
 
     def callback(ctx: click.Context, param: click.Parameter, value: bool) -> None:  # noqa: FBT001, ARG001
         if not value or ctx.resilient_parsing:
             return
 
-        first_zones = ["localtime", "UTC"]
+        click.echo("localtime")  # special local time handle
+        click.echo(get_localzone_name())
+        click.echo("UTC")
         all_zones = zoneinfo.available_timezones()
-        for zone in first_zones:
-            if zone in all_zones:
-                click.echo(zone)
         for zone in sorted(all_zones, key=str.lower):
             click.echo(zone)
         ctx.exit()

{ics_query-0.3.1b0 → ics_query-0.3.3b0}/ics_query/query.py

@@ -23,6 +23,7 @@ from typing import TYPE_CHECKING
 
 import x_wr_timezone
 from recurring_ical_events import CalendarQuery, Occurrence
+from tzlocal import get_localzone
 
 if TYPE_CHECKING:
     from collections.abc import Sequence
@@ -38,7 +39,13 @@ class Query(CalendarQuery):
             components=components,
             skip_bad_series=True,
         )
-        self.timezone = zoneinfo.ZoneInfo(timezone) if timezone else None
+        self.timezone = self.get_timezone(timezone)
+
+    def get_timezone(self, timezone: str) -> datetime.tzinfo | None:
+        """Return the local time tz."""
+        if timezone == "localtime":
+            return get_localzone()
+        return zoneinfo.ZoneInfo(timezone) if timezone else None
 
     def with_timezone(self, dt: datetime.date | datetime.datetime):
         """Add the timezone."""

{ics_query-0.3.1b0 → ics_query-0.3.3b0}/ics_query/tests/conftest.py

@@ -18,7 +18,6 @@
 from __future__ import annotations
 
 import subprocess
-from copy import deepcopy
 from pathlib import Path
 from typing import Callable, NamedTuple
 
@@ -50,14 +49,28 @@ class TestRun(NamedTuple):
         )
 
 
-def run_ics_query(*command, cwd=CALENDARS_DIRECTORY) -> TestRun:
-    """Run ics-qeury with a command."""
-    cmd = ["ics-query", *command]
-    print(" ".join(cmd))
+def get_binary_path(request: pytest.FixtureRequest) -> str:
+    """Return the path to the ics-query command."""
+    command: str = request.config.getoption("--binary")
+    if command == "ics-query":
+        # The default command can be found on the command line
+        return command
+    # we must set the path to be absolute
+    return Path(command).absolute()
+
+
+def run_ics_query(*command, cwd=CALENDARS_DIRECTORY, binary: str) -> TestRun:
+    """Run ics-qeury with a command.
+
+    - cwd is the working directory
+    - binary is the path to the command
+    """
+    cmd = [binary, *command]
+    print(" ".join(map(str, cmd)))
     completed_process = subprocess.run(  # noqa: S603, RUF100
         cmd,  # noqa: S603, RUF100
         capture_output=True,
-        timeout=3,
+        timeout=10,
         check=False,
         cwd=cwd,
     )
@@ -71,35 +84,43 @@ class IOTestCase(NamedTuple):
     command: list[str]
     location: Path
     expected_output: str
+    binary: str
 
     @classmethod
-    def from_path(cls, path: Path) -> IOTestCase:
+    def from_path(cls, path: Path, binary: str) -> IOTestCase:
         """Create a new testcase from the files."""
         expected_output = path.read_text(encoding="UTF-8").replace("\r\n", "\n")
-        return cls(path.name, path.stem.split(), path.parent, expected_output)
+        return cls(path.name, path.stem.split(), path.parent, expected_output, binary)
 
     def run(self) -> TestRun:
         """Run this test case and return the result."""
-        return run_ics_query(*self.command)
+        return run_ics_query(*self.command, binary=self.binary)
 
 
-io_test_cases = [
-    IOTestCase.from_path(test_case_path)
+io_test_case_paths = [
+    test_case_path
     for test_case_path in IO_DIRECTORY.iterdir()
     if test_case_path.is_file()
 ]
 
 
-@pytest.fixture(params=io_test_cases)
-def io_testcase(request) -> IOTestCase:
+@pytest.fixture(params=io_test_case_paths)
+def io_testcase(request: pytest.FixtureRequest) -> IOTestCase:
     """Go though all the IO test cases."""
-    return deepcopy(request.param)
+    path: Path = request.param
+    binary = get_binary_path(request)
+    return IOTestCase.from_path(path, binary)
 
 
 @pytest.fixture
-def run() -> Callable[..., TestRun]:
+def run(request: pytest.FixtureRequest) -> Callable[..., TestRun]:
     """Return a runner function."""
-    return run_ics_query
+
+    def run(*args, **kw):
+        kw["binary"] = get_binary_path(request)
+        return run_ics_query(*args, **kw)
+
+    return run
 
 
 __all__ = ["IOTestCase", "TestRun"]

ics_query-0.3.3b0/ics_query/tests/runs/calendars/one-event-without-timezone.ics

@@ -0,0 +1,14 @@
+BEGIN:VCALENDAR
+VERSION:2.0
+PRODID:-//SabreDAV//SabreDAV//EN
+CALSCALE:GREGORIAN
+BEGIN:VEVENT
+CREATED:20190303T111937
+DTSTAMP:20190303T111937
+LAST-MODIFIED:20190303T111937
+UID:UYDQSG9TH4DE0WM3QFL2J
+SUMMARY:test1
+DTSTART:20190304T080000
+DTEND:20190304T083000
+END:VEVENT
+END:VCALENDAR

{ics_query-0.3.1b0 → ics_query-0.3.3b0}/ics_query/tests/test_command_line.py

@@ -15,6 +15,8 @@
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
 """Test the commmand line."""
 
+from tzlocal import get_localzone_name
+
 from ics_query.version import version
 
 from .conftest import IOTestCase
@@ -51,3 +53,20 @@ def test_timezones(run):
     assert tz.index("Zulu") > tz.index("Pacific/Nauru")
     assert tz.index("Pacific/Nauru") > tz.index("UTC")
     assert tz.index("UTC") > tz.index("localtime")
+
+
+def test_special_timezones(run):
+    """Make sure we show special timezones first."""
+    result = run("--available-timezones")
+    tz = result.output.split()
+    assert result.exit_code == 0
+    assert tz[0] == "localtime"
+    assert tz[1] == get_localzone_name()
+    assert tz[2] == "UTC"
+
+
+def test_localtime_is_not_in_the_result_string(run):
+    """We do not want 'localtime' to turn up as the result tz name."""
+    result = run("first", "--tz", "localtime", "one-event-without-timezone.ics")
+    assert f"DTSTART;TZID={get_localzone_name()}:201903" in result.output
+    assert f"DTEND;TZID={get_localzone_name()}:201903" in result.output

{ics_query-0.3.1b0 → ics_query-0.3.3b0}/pyproject.toml

@@ -49,6 +49,7 @@ dependencies = [
     "recurring-ical-events>=3.2.0,<4",
     "click",
     "x-wr-timezone",
+    "tzlocal",
 ]
 
 [project.optional-dependencies]

{ics_query-0.3.1b0 → ics_query-0.3.3b0}/tox.ini

@@ -8,6 +8,9 @@ skipsdist = True
 envlist = py39, py310, py311, py312, ruff
 
 [testenv]
+#
+# Run the tests
+#
 deps =
     -e {tox_root}[test]
 setenv = TMPDIR={envtmpdir}
@@ -15,8 +18,32 @@ commands =
     pytest --basetemp="{envtmpdir}" {posargs}
 
 [testenv:ruff]
+#
+# Format the code according to convention
+#
 deps = ruff
 skip_install = True
 commands =
     ruff format
     ruff check --fix
+
+[testenv:build]
+#
+# Build the distribution files
+#
+deps = build
+skip_install = True
+commands =
+    python -m build .
+
+[testenv:exe]
+#
+# Create a Windows executable and run the tests with it
+#
+skip_install = True
+deps =
+    pyinstaller
+    -e .[test]
+commands =
+    pyinstaller ics-query.py --onefile --paths "{env_site_packages_dir}" --recursive-copy-metadata ics-query
+    pytest --binary .\dist\ics-query.exe