dron 0.1.20241008__tar.gz → 0.2.20251011__tar.gz

dron-0.2.20251011/.ci/release-uv

@@ -0,0 +1,56 @@
+#!/usr/bin/env python3
+'''
+Deploys Python package onto [[https://pypi.org][PyPi]] or [[https://test.pypi.org][test PyPi]].
+
+- running manually
+
+  You'll need =UV_PUBLISH_TOKEN= env variable
+
+- running on Github Actions
+
+  Instead of env variable, relies on configuring github as Trusted publisher (https://docs.pypi.org/trusted-publishers/) -- both for test and regular pypi
+
+  It's running as =pypi= job in [[file:.github/workflows/main.yml][Github Actions config]].
+  Packages are deployed on:
+  - every master commit, onto test pypi
+  - every new tag, onto production pypi
+'''
+
+UV_PUBLISH_TOKEN = 'UV_PUBLISH_TOKEN'
+
+import argparse
+import os
+import shutil
+from pathlib import Path
+from subprocess import check_call
+
+is_ci = os.environ.get('CI') is not None
+
+
+def main() -> None:
+    p = argparse.ArgumentParser()
+    p.add_argument('--use-test-pypi', action='store_true')
+    args = p.parse_args()
+
+    publish_url = ['--publish-url', 'https://test.pypi.org/legacy/'] if args.use_test_pypi else []
+
+    root = Path(__file__).absolute().parent.parent
+    os.chdir(root)  # just in case
+
+    # TODO ok, for now uv won't remove dist dir if it already exists
+    #  https://github.com/astral-sh/uv/issues/10293
+    dist = root / 'dist'
+    if dist.exists():
+        shutil.rmtree(dist)
+
+    check_call(['uv', 'build'])
+
+    if not is_ci:
+        # CI relies on trusted publishers so doesn't need env variable
+        assert UV_PUBLISH_TOKEN in os.environ, f'no {UV_PUBLISH_TOKEN} passed'
+
+    check_call(['uv', 'publish', *publish_url])
+
+
+if __name__ == '__main__':
+    main()

{dron-0.1.20241008 → dron-0.2.20251011}/.ci/run

@@ -11,6 +11,8 @@ if ! command -v sudo; then
     }
 fi
 
+# --parallel-live to show outputs while it's running
+tox_cmd='run-parallel --parallel-live'
 if [ -n "${CI-}" ]; then
     # install OS specific stuff here
     case "$OSTYPE" in
@@ -20,7 +22,8 @@ if [ -n "${CI-}" ]; then
         ;;
     cygwin* | msys* | win*)
         # windows
-        :
+        # ugh. parallel stuff seems super flaky under windows, some random failures, "file used by other process" and crap like that
+        tox_cmd='run'
         ;;
     *)
         # must be linux?
@@ -30,12 +33,5 @@ if [ -n "${CI-}" ]; then
     esac
 fi
 
-
-PY_BIN="python3"
-# some systems might have python pointing to python3
-if ! command -v python3 &> /dev/null; then
-    PY_BIN="python"
-fi
-
-"$PY_BIN" -m pip install --user tox
-"$PY_BIN" -m tox --parallel --parallel-live "$@"
+# NOTE: expects uv installed
+uv tool run --with tox-uv tox $tox_cmd "$@"

dron-0.2.20251011/.github/workflows/main.yml

@@ -0,0 +1,117 @@
+# see https://github.com/karlicoss/pymplate for up-to-date reference
+
+name: CI
+on:
+  push:
+    branches: '*'
+    tags: 'v[0-9]+.*' # only trigger on 'release' tags for PyPi
+    # Ideally I would put this in the pypi job... but github syntax doesn't allow for regexes there :shrug:
+
+  # Needed to trigger on others' PRs.
+  # Note that people who fork it need to go to "Actions" tab on their fork and click "I understand my workflows, go ahead and enable them".
+  pull_request:
+
+  # Needed to trigger workflows manually.
+  workflow_dispatch:
+    inputs:
+      debug_enabled:
+        type: boolean
+        description: 'Run the build with tmate debugging enabled (https://github.com/marketplace/actions/debugging-with-tmate)'
+        required: false
+        default: false
+
+  schedule:
+    - cron: '31 18 * * 5'  # run every Friday
+
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        platform: [ubuntu-latest, macos-latest]
+        python-version: ['3.12', '3.13', '3.14']
+        # vvv just an example of excluding stuff from matrix
+        # exclude: [{platform: macos-latest, python-version: '3.6'}]
+
+    runs-on: ${{ matrix.platform }}
+
+    # useful for 'optional' pipelines
+    # continue-on-error: ${{ matrix.platform == 'windows-latest' }}
+
+    steps:
+    # ugh https://github.com/actions/toolkit/blob/main/docs/commands.md#path-manipulation
+    - run: echo "$HOME/.local/bin" >> $GITHUB_PATH
+
+    - uses: actions/checkout@v5
+      with:
+        submodules: recursive
+        fetch-depth: 0  # nicer to have all git history when debugging/for tests
+
+    - uses: actions/setup-python@v6
+      with:
+        python-version: ${{ matrix.python-version }}
+      
+    - uses: astral-sh/setup-uv@v7
+      with:
+        enable-cache: false  # we don't have lock files, so can't use them as cache key
+
+    - uses: mxschmitt/action-tmate@v3
+      if: ${{ github.event_name == 'workflow_dispatch' && inputs.debug_enabled }}
+
+    # explicit bash command is necessary for Windows CI runner, otherwise it thinks it's cmd...
+    - run: bash .ci/run
+      env:
+        # only compute lxml coverage on ubuntu; it crashes on windows
+        CI_MYPY_COVERAGE: ${{ matrix.platform == 'ubuntu-latest' && '--cobertura-xml-report .coverage.mypy' || '' }}
+
+    - if: matrix.platform == 'ubuntu-latest'  # no need to compute coverage for other platforms
+      uses: codecov/codecov-action@v5
+      with:
+        fail_ci_if_error: true  # default false
+        token: ${{ secrets.CODECOV_TOKEN }}
+        flags: mypy-${{ matrix.python-version }}
+        files: .coverage.mypy/cobertura.xml
+
+
+  pypi:
+    # Do not run it for PRs/cron schedule etc.
+    # NOTE: release tags are guarded by on: push: tags on the top.
+    if: github.event_name == 'push' && (startsWith(github.event.ref, 'refs/tags/') || (github.event.ref == format('refs/heads/{0}', github.event.repository.master_branch)))
+    # Ugh, I tried using matrix or something to explicitly generate only test pypi or prod pypi pipelines.
+    # But github actions is so shit, it's impossible to do any logic at all, e.g. doesn't support conditional matrix, if/else statements for variables etc.
+
+    needs: [build] # add all other jobs here
+
+    runs-on: ubuntu-latest
+
+    permissions:
+      # necessary for Trusted Publishing
+      id-token: write
+
+    steps:
+    # ugh https://github.com/actions/toolkit/blob/main/docs/commands.md#path-manipulation
+    - run: echo "$HOME/.local/bin" >> $GITHUB_PATH
+
+    - uses: actions/checkout@v5
+      with:
+        submodules: recursive
+        fetch-depth: 0  # pull all commits to correctly infer vcs version
+
+    - uses: actions/setup-python@v6
+      with:
+        python-version: '3.12'
+
+    - uses: astral-sh/setup-uv@v7
+      with:
+        enable-cache: false  # we don't have lock files, so can't use them as cache key
+
+    - name: 'release to test pypi'
+      # always deploy merged master to test pypi
+      if: github.event.ref == format('refs/heads/{0}', github.event.repository.master_branch)
+      run: .ci/release-uv --use-test-pypi
+
+    - name: 'release to prod pypi'
+      # always deploy tags to release pypi
+      if: startsWith(github.event.ref, 'refs/tags/')
+      run: .ci/release-uv

{dron-0.1.20241008/src/dron.egg-info → dron-0.2.20251011}/PKG-INFO

@@ -1,6 +1,8 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: dron
-Version: 0.1.20241008
+Version: 0.2.20251011
+Summary: What if cron and systemd had a baby?
+Project-URL: Homepage, https://github.com/karlicoss/dron
 Author-email: "Dima Gerasimov (@karlicoss)" <karlicoss@gmail.com>
 Maintainer-email: "Dima Gerasimov (@karlicoss)" <karlicoss@gmail.com>
 License: The MIT License (MIT)
@@ -24,23 +26,16 @@ License: The MIT License (MIT)
         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         SOFTWARE.
-        
-Project-URL: Homepage, https://github.com/karlicoss/dron
-Requires-Python: >=3.9
 License-File: LICENSE.txt
+Requires-Python: >=3.12
 Requires-Dist: click
-Requires-Dist: prompt_toolkit
-Requires-Dist: tzlocal
-Requires-Dist: textual
+Requires-Dist: dbus-python; platform_system != 'Darwin'
+Requires-Dist: loguru
+Requires-Dist: mypy
+Requires-Dist: prompt-toolkit
 Requires-Dist: tabulate
 Requires-Dist: termcolor
-Requires-Dist: mypy
-Requires-Dist: loguru
-Requires-Dist: dbus-python; platform_system != "Darwin"
-Provides-Extra: testing
-Requires-Dist: pytest; extra == "testing"
-Requires-Dist: ruff; extra == "testing"
-Requires-Dist: mypy; extra == "testing"
-Requires-Dist: lxml; extra == "testing"
+Requires-Dist: textual
+Requires-Dist: tzlocal
 Provides-Extra: notify-telegram
-Requires-Dist: telegram-send>=0.37; extra == "notify-telegram"
+Requires-Dist: telegram-send>=0.37; extra == 'notify-telegram'

{dron-0.1.20241008 → dron-0.2.20251011}/README.org

@@ -1,3 +1,6 @@
+NOTE: readme is a little outdated (although mostly correct).
+Best source of truth is =--help=.
+
 #+begin_src python :results drawer :exports results 
 import dron; return dron.make_parser().description
 #+end_src

{dron-0.1.20241008 → dron-0.2.20251011}/conftest.py

@@ -4,7 +4,6 @@
 
 import os
 import pathlib
-from typing import Optional
 
 import _pytest.main
 import _pytest.pathlib
@@ -20,7 +19,9 @@ namespace_pkg_dirs = [str(d) for d in root_dir.iterdir() if d.is_dir()]
 # resolve_package_path is called from _pytest.pathlib.import_path
 # takes a full abs path to the test file and needs to return the path to the 'root' package on the filesystem
 resolve_pkg_path_orig = _pytest.pathlib.resolve_package_path
-def resolve_package_path(path: pathlib.Path) -> Optional[pathlib.Path]:
+
+
+def resolve_package_path(path: pathlib.Path) -> pathlib.Path | None:
     result = path  # search from the test file upwards
     for parent in result.parents:
         if str(parent) in namespace_pkg_dirs:
@@ -30,7 +31,12 @@ def resolve_package_path(path: pathlib.Path) -> Optional[pathlib.Path]:
         if path.name == 'conftest.py':
             return resolve_pkg_path_orig(path)
     raise RuntimeError("Couldn't determine path for ", path)
-_pytest.pathlib.resolve_package_path = resolve_package_path
+
+
+# NOTE: seems like it's not necessary anymore?
+# keeping it for now just in case
+# after https://github.com/pytest-dev/pytest/pull/13426 we should be able to remove the whole conftest
+# _pytest.pathlib.resolve_package_path = resolve_package_path
 
 
 # without patching, the orig function returns just a package name for some reason
@@ -38,10 +44,14 @@ _pytest.pathlib.resolve_package_path = resolve_package_path
 # so we need to point it at the absolute path properly
 # not sure what are the consequences.. maybe it wouldn't be able to run against installed packages? not sure..
 search_pypath_orig = _pytest.main.search_pypath
+
+
 def search_pypath(module_name: str) -> str:
     mpath = root_dir / module_name.replace('.', os.sep)
     if not mpath.is_dir():
         mpath = mpath.with_suffix('.py')
         assert mpath.exists(), mpath  # just in case
     return str(mpath)
-_pytest.main.search_pypath = search_pypath
+
+
+_pytest.main.search_pypath = search_pypath  # ty: ignore[invalid-assignment]

{dron-0.1.20241008 → dron-0.2.20251011}/mypy.ini

@@ -3,11 +3,14 @@ pretty = True
 show_error_context = True
 show_column_numbers = True
 show_error_end = True
-warn_redundant_casts = True
-warn_unused_ignores = True
+
 check_untyped_defs = True
+
+# see https://mypy.readthedocs.io/en/stable/error_code_list2.html
+warn_redundant_casts = True
 strict_equality = True
-enable_error_code = possibly-undefined
+warn_unused_ignores = True
+enable_error_code = deprecated,redundant-expr,possibly-undefined,truthy-bool,truthy-iterable,ignore-without-code,unused-awaitable
 
 # an example of suppressing
 # [mypy-my.config.repos.pdfannots.pdfannots]

{dron-0.1.20241008 → dron-0.2.20251011}/pyproject.toml

@@ -1,6 +1,6 @@
 # see https://github.com/karlicoss/pymplate for up-to-date reference
 [project]
-dynamic = ["version"]  # version is managed by setuptools_scm
+dynamic = ["version"]  # version is managed by build backend
 name = "dron"
 dependencies = [
     "click"         ,  # CLI
@@ -13,10 +13,11 @@ dependencies = [
     "loguru"        ,  # nicer logging
     "dbus-python; platform_system != 'Darwin'",  # dbus interface to systemd
 ]
-requires-python = ">=3.9"
+requires-python = ">=3.12"
 # FIXME dbus
 
 ## these need to be set if you're planning to upload to pypi
+description = "What if cron and systemd had a baby?"
 license = {file = "LICENSE.txt"}
 authors = [
     {name = "Dima Gerasimov (@karlicoss)", email = "karlicoss@gmail.com"},
@@ -24,33 +25,42 @@ authors = [
 maintainers = [
     {name = "Dima Gerasimov (@karlicoss)", email = "karlicoss@gmail.com"},
 ]
-
 [project.urls]
 Homepage = "https://github.com/karlicoss/dron"
 ##
 
-[project.scripts]
-dron = "dron.__main__:main"
 
 [project.optional-dependencies]
-testing = [
-    "pytest",
-    "ruff",
-    "mypy",
-    "lxml",  # for mypy html coverage
-]
 notify-telegram = [
     # version before that had a bug that prevented it from working
     # see https://github.com/rahiel/telegram-send/issues/115#issuecomment-1368728425
     "telegram-send>=0.37",
 ]
+[dependency-groups]
+testing = [
+    "pytest",
+    "ruff",
+    "mypy",
+    "lxml", # for mypy html coverage
+    "types-tabulate",
+    "ty>=0.0.1a22",
+]
+
+[project.scripts]
+dron = "dron.__main__:main"
 
 
 [build-system]
-requires = ["setuptools", "setuptools-scm"]
-build-backend = "setuptools.build_meta"
+requires = ["hatchling", "hatch-vcs"]
+build-backend = "hatchling.build"
+
+# unfortunately have to duplicate project name here atm, see https://github.com/pypa/hatch/issues/1894
+[tool.hatch.build.targets.wheel]
+packages = ["src/dron"]
 
-[tool.setuptools_scm]
+[tool.hatch.version]
+source = "vcs"
+
+[tool.hatch.version.raw-options]
 version_scheme = "python-simplified-semver"
 local_scheme = "dirty-tag"
-

{dron-0.1.20241008 → dron-0.2.20251011}/pytest.ini

@@ -1,7 +1,14 @@
 [pytest]
 # discover files that don't follow test_ naming. Useful to keep tests along with the source code
 python_files = *.py
+
+# this setting only impacts package/module naming under pytest, not the discovery
+consider_namespace_packages = true
+
 addopts =
+  # prevent pytest cache from being created... it craps into project dir and I never use it anyway
+  -p no:cacheprovider
+
   # -rap to print tests summary even when they are successful
   -rap
   --verbose

{dron-0.1.20241008 → dron-0.2.20251011}/ruff.toml

@@ -1,36 +1,7 @@
+line-length = 120  # impacts import sorting
+
 lint.extend-select = [
-    "F",    # flakes rules -- default, but extend just in case
-    "E",    # pycodestyle  -- default, but extend just in case
-    "W",    # various warnings
-
-    "B",    # 'bugbear' set -- various possible bugs
-    "C4",   # flake8-comprehensions -- unnecessary list/map/dict calls
-    "COM",  # trailing commas
-    "EXE",  # various checks wrt executable files
-    "I",    # sort imports
-    "ICN",  # various import conventions
-    "FBT",  # detect use of boolean arguments
-    "FURB", # various rules
-    "PERF", # various potential performance speedups
-    "PD",   # pandas rules
-    "PIE",  # 'misc' lints
-    "PLC",  # pylint convention rules
-    "PLR",  # pylint refactor rules
-    "PLW",  # pylint warnings
-    "PT",   # pytest stuff
-    "PYI",  # various type hinting rules
-    "RET",  # early returns
-    "RUF",  # various ruff-specific rules
-    "TID",  # various imports suggestions
-    "TRY",  # various exception handling rules
-    "UP",   # detect deprecated python stdlib stuff
-    "FA",   # suggest using from __future__ import annotations
-    "PTH",  # pathlib migration
-    "ARG",  # unused argument checks
-    "A",    # builtin shadowing
-    # "EM",  # TODO hmm could be helpful to prevent duplicate err msg in traceback.. but kinda annoying
-
-    # "ALL", # uncomment this to check for new rules!
+    "ALL",
 ]
 
 lint.ignore = [
@@ -42,10 +13,10 @@ lint.ignore = [
     "FIX",   # complains about fixmes/todos -- annoying
     "TD",    # complains about todo formatting -- too annoying
     "ANN",   # missing type annotations? seems way to strict though
+    "EM" ,   # suggests assigning all exception messages into a variable first... pretty annoying
 
 ### too opinionated style checks
     "E501",  # too long lines
-    "E702",  # Multiple statements on one line (semicolon)
     "E731",  # assigning lambda instead of using def
     "E741",  # Ambiguous variable name: `l`
     "E742",  # Ambiguous class name: `O
@@ -60,15 +31,6 @@ lint.ignore = [
 ## might be nice .. but later and I don't wanna make it strict
     "E402",  # Module level import not at top of file
 
-### maybe consider these soon
-    # sometimes it's useful to give a variable a name even if we don't use it as a documentation
-    # on the other hand, often is a sign of error
-    "F841",  # Local variable `count` is assigned to but never used
-###
-
-    "RUF100",  # unused noqa -- handle later
-    "RUF012",  # mutable class attrs should be annotated with ClassVar... ugh pretty annoying for user configs
-
 ### these are just nitpicky, we usually know better
     "PLR0911",  # too many return statements
     "PLR0912",  # too many branches
@@ -83,10 +45,8 @@ lint.ignore = [
 
     "B009",  # calling gettattr with constant attribute -- this is useful to convince mypy
     "B010",  # same as above, but setattr
-    "B011",  # complains about assert False
     "B017",  # pytest.raises(Exception)
     "B023",  # seems to result in false positives?
-    "B028",  # suggest using explicit stacklevel? TODO double check later, but not sure it's useful
 
     # complains about useless pass, but has sort of a false positive if the function has a docstring?
     # this is common for click entrypoints (e.g. in __main__), so disable
@@ -106,28 +66,19 @@ lint.ignore = [
     "PLW0603",  # global variable update.. we usually know why we are doing this
     "PLW2901",  # for loop variable overwritten, usually this is intentional
 
-    "PT004",  # deprecated rule, will be removed later
-    "PT011",  # pytest raises should is too broad
-    "PT012",  # pytest raises should contain a single statement
+    "PT011",  # pytest raises is too broad
 
     "COM812",  # trailing comma missing -- mostly just being annoying with long multiline strings
 
-    "PD901",   # generic variable name df
-
     "TRY003",  # suggests defining exception messages in exception class -- kinda annoying
-    "TRY004",  # prefer TypeError -- don't see the point
     "TRY201",  # raise without specifying exception name -- sometimes hurts readability
-    "TRY400",  # TODO double check this, might be useful
+    "TRY400",  # a bit dumb, and results in false positives (see https://github.com/astral-sh/ruff/issues/18070)
     "TRY401",  # redundant exception in logging.exception call? TODO double check, might result in excessive logging
 
-    "PGH",  # TODO force error code in mypy instead
-
     "TID252",  # Prefer absolute imports over relative imports from parent modules
 
-    "UP038",  # suggests using | (union) in isisntance checks.. but it results in slower code
-
     ## too annoying
-    "T20",     # just complains about prints and pprints
+    "T20",     # just complains about prints and pprints (TODO maybe consider later?)
     "Q",       # flake quotes, too annoying
     "C90",     # some complexity checking
     "G004",    # logging statement uses f string
@@ -135,7 +86,14 @@ lint.ignore = [
     "SLF001",  # private member accessed
     "BLE001",  # do not catch 'blind' Exception
     "INP001",  # complains about implicit namespace packages
-    "SIM",     # some if statements crap
+    "SIM102",  # if statements collapsing, often hurts readability
+    "SIM103",  # multiple conditions collapsing, often hurts readability
+    "SIM105",  # suggests using contextlib.suppress instad of try/except -- this wouldn't be mypy friendly
+    "SIM108",  # suggests using ternary operation instead of if -- hurts readability
+    "SIM110",  # suggests using any(...) instead of for look/return -- hurts readability
+    "SIM117",  # suggests using single with statement instead of nested -- doesn't work in tests
     "RSE102",  # complains about missing parens in exceptions
     ##
+
+    "PLC0415", # "imports should be at the top level" -- not realistic
 ]

{dron-0.1.20241008 → dron-0.2.20251011}/src/dron/api.py

@@ -4,8 +4,8 @@ import getpass
 import inspect
 import re
 import sys
+from collections.abc import Sequence
 from dataclasses import dataclass
-from typing import Sequence
 
 from .common import (
     IS_SYSTEMD,
@@ -19,6 +19,7 @@ OnFailureAction = str
 
 UnitName = str
 
+
 @dataclass
 class Job:
     when: When | None
@@ -95,12 +96,12 @@ def job(
 
 
 __all__ = (
-    'When',
+    'Command',
+    'Job',  # todo maybe don't expose it?
     'OnCalendar',
     'OnFailureAction',
-    'Command',
-    'wrap',
+    'When',
     'job',
     'notify',
-    'Job',  # todo maybe don't expose it?
+    'wrap',
 )