generate-systemd-timer 0.1.3__tar.gz → 2.0.0__tar.gz

generate_systemd_timer-2.0.0/.github/dependabot.yml

@@ -0,0 +1,20 @@
+---
+version: 2
+
+updates:
+  - package-ecosystem: pip
+    directory: /
+    schedule:
+      interval: monthly
+    groups:
+      python-packages:
+        patterns:
+          - "*"
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: monthly
+    groups:
+      github-actions:
+        patterns:
+          - "*"

generate_systemd_timer-2.0.0/.github/workflows/main.yml

@@ -0,0 +1,53 @@
+name: Publish tags
+on: push
+
+jobs:
+  build:
+    name: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+      - name: Build and check
+        run: |
+          uv build
+          uvx twine check dist/*
+      - name: Upload build artifact
+        uses: actions/upload-artifact@v7
+        with:
+          name: "builds"
+          path: "dist/*"
+          if-no-files-found: error
+      - name: Check tag name if we're to publish
+        if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
+        run: |
+          if ! [[ "v$(uv version --short)" == "${GITHUB_REF##*/}" ]]; then
+            echo "Tag does not match!"
+            exit 1
+          fi
+  pypi-publish:
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/generate-systemd-timer
+    needs: build
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
+    permissions:
+      id-token: write
+      contents: write
+    steps:
+      - name: "Download build artifacts"
+        uses: actions/download-artifact@v8
+        with:
+          name: "builds"
+          path: "dist/"
+      - name: Create release on Github
+        uses: softprops/action-gh-release@v3
+        with:
+          files: |
+            dist/*
+      - name: "Publish to pypi"
+        uses: pypa/gh-action-pypi-publish@v1.14.0

generate_systemd_timer-2.0.0/.github/workflows/tests.yml

@@ -0,0 +1,37 @@
+name: Tests
+on:
+  push:
+  pull_request:
+
+jobs:
+  lint:
+    name: ruff
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+      - name: Ruff lint
+        run: uvx ruff check .
+      - name: Ruff format check
+        run: uvx ruff format --check .
+
+  test:
+    name: pytest (py${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        # uv provides every interpreter, so 3.8 works on ubuntu-latest too.
+        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12', '3.13']
+    steps:
+      - uses: actions/checkout@v6
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+          python-version: ${{ matrix.python-version }}
+      - name: Run pytest
+        run: uv run --frozen pytest

generate_systemd_timer-2.0.0/.gitignore

@@ -0,0 +1,143 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# static files generated from Django application using `collectstatic`
+media
+static

generate_systemd_timer-2.0.0/PKG-INFO

@@ -0,0 +1,29 @@
+Metadata-Version: 2.4
+Name: generate-systemd-timer
+Version: 2.0.0
+Summary: Generate a systemd unit.timer and unit.service pair
+Project-URL: Repository, https://github.com/thomwiggers/systemd-timer-generator
+Author-email: Thom Wiggers <thom@thomwiggers.nl>
+License-Expression: MIT
+Requires-Python: >=3.8
+Requires-Dist: jinja2<4,>=3
+Requires-Dist: python-editor<2,>=1.0
+Requires-Dist: setuptools<76.0,>=70.3
+Description-Content-Type: text/markdown
+
+# Systemd generator for timer units
+
+Generates systemd `.timer` and `.service` units to more easily add cron-like tasks to your system.
+
+After editing the units, the tool can install them for you: copy them into
+`/etc/systemd/system` or `$HOME/.config/systemd/user` (creating the directory if
+needed), run `systemctl daemon-reload`, and enable and start the timer.
+
+## Usage
+
+```sh
+generate-systemd-timer unit-name
+# Now two editors will pop up to allow you to customize
+# Afterwards you'll find unit-name.service and unit-name.timer in the current folder.
+# Finally, you'll be asked whether to install, reload and enable the timer.
+```

{generate_systemd_timer-0.1.3 → generate_systemd_timer-2.0.0}/README.md

@@ -2,8 +2,9 @@
 
 Generates systemd `.timer` and `.service` units to more easily add cron-like tasks to your system.
 
-You'll still have to copy them into the right place (either `/etc/systemd/system`
-or `$HOME/.config/systemd/user`) and reload systemd using `systemctl daemon-reload`.
+After editing the units, the tool can install them for you: copy them into
+`/etc/systemd/system` or `$HOME/.config/systemd/user` (creating the directory if
+needed), run `systemctl daemon-reload`, and enable and start the timer.
 
 ## Usage
 
@@ -11,4 +12,5 @@ or `$HOME/.config/systemd/user`) and reload systemd using `systemctl daemon-relo
 generate-systemd-timer unit-name
 # Now two editors will pop up to allow you to customize
 # Afterwards you'll find unit-name.service and unit-name.timer in the current folder.
+# Finally, you'll be asked whether to install, reload and enable the timer.
 ```

generate_systemd_timer-2.0.0/pyproject.toml

@@ -0,0 +1,49 @@
+[project]
+name = "generate-systemd-timer"
+version = "2.0.0"
+description = "Generate a systemd unit.timer and unit.service pair"
+license = "MIT"
+readme = "README.md"
+requires-python = ">=3.8"
+authors = [
+    { name = "Thom Wiggers", email = "thom@thomwiggers.nl" },
+]
+dependencies = [
+    "jinja2>=3,<4",
+    "python-editor>=1.0,<2",
+    "setuptools>=70.3,<76.0",
+]
+
+[project.urls]
+Repository = "https://github.com/thomwiggers/systemd-timer-generator"
+
+[project.scripts]
+generate-systemd-timer = "systemd_generator:main"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["systemd_generator"]
+
+[dependency-groups]
+dev = [
+    "pytest>=8,<9",
+]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "-ra"
+
+[tool.ruff]
+target-version = "py38"
+
+[tool.ruff.lint]
+select = [
+    "E",   # pycodestyle errors
+    "F",   # pyflakes
+    "I",   # isort
+    "UP",  # pyupgrade
+    "B",   # flake8-bugbear
+]

generate_systemd_timer-2.0.0/systemd_generator/__init__.py

@@ -0,0 +1,197 @@
+"""Generate systemd timer files"""
+
+import os
+import subprocess
+import sys
+
+import editor
+import jinja2
+
+USER_UNIT_DIR = os.path.expanduser("~/.config/systemd/user")
+SYSTEM_UNIT_DIR = "/etc/systemd/system"
+
+
+TEMPLATE_TIMER = """\
+[Unit]
+Description=Generated timer for {{ service_name }} by {{ script_name }}
+
+[Timer]
+#Unit={{ service_name }}.service
+
+# Select one of the following
+# OnCalendar: daily / weekly / monthly
+#OnCalendar=
+# OnActiveSec: Time after this timer has been loaded
+#OnActiveSec=
+# OnBootSec: Time relative to boot
+#OnBootSec=
+# OnStartupSec: Time relative to systemd manager start; relevant for user login
+#OnStartupSec=
+# OnUnitActiveSec: Defines it relative to when the to-be-started unit was last activated
+#OnUnitActiveSec=
+# OnUnitInactiveSec: Defines it relative to when the to-be-started unit
+# was last deactivated
+#OnUnitInactiveSec=
+
+# Optional settings
+# AccuracySec: Defines the accuracy with which this timer shall elapse
+#AccuracySec=1m
+# RandomizedDelaySec: Defines a randomized delay to be added to the start time
+#RandomizedDelaySec=0
+# Persistent: Also activate if the timer expired while timer was inactive
+# Only relevant for OnCalendar
+#Persistent=false
+
+# Probably not necessary
+# OnClockChange: Activate this unit whenever the clock jumps
+#OnClockChange=false
+# OnTimezoneChange: Activate whenever the timezone changes
+#OnTimezoneChange=false
+# WakeSystem: Resume the system from suspend to activate (if supported)
+#WakeSystem=false
+# RemainAfterElapse: Keeps the timer in the service manager once elapsed.
+#RemainAfterElapse=true
+
+[Install]
+WantedBy=timers.target
+
+# vim : set ft=systemd.timer :
+"""
+
+TEMPLATE_SERVICE = """\
+[Unit]
+Description=Generated service for {{ service_name }} by {{ script_name }}
+
+[Service]
+Type=oneshot
+ExecStart=/bin/true
+
+[Install]
+WantedBy=multi-user.target
+
+# See https://www.freedesktop.org/software/systemd/man/systemd.service.html#Examples
+
+# vim : set ft=systemd.service :
+"""
+
+
+def _get_jinja_environment():
+    env = jinja2.Environment()
+    return env
+
+
+def _render_timer(service_name):
+    """Render the systemd.template file"""
+    script_name = sys.argv[0]
+    template = _get_jinja_environment().from_string(TEMPLATE_TIMER)
+    return template.render(
+        service_name=service_name,
+        script_name=script_name,
+    )
+
+
+def _render_service(service_name):
+    """Render the systemd.service file"""
+    script_name = sys.argv[0]
+    template = _get_jinja_environment().from_string(TEMPLATE_SERVICE)
+    return template.render(
+        service_name=service_name,
+        script_name=script_name,
+    )
+
+
+def _prompt_yes_no(question, default=False):
+    """Ask a yes/no question on stdin. Returns the default if non-interactive."""
+    if not sys.stdin.isatty():
+        return default
+    options = "[Y/n]" if default else "[y/N]"
+    try:
+        answer = input(f"{question} {options} ").strip().lower()
+    except EOFError:
+        return default
+    if not answer:
+        return default
+    return answer in ("y", "yes")
+
+
+def _run(cmd):
+    """Echo and run a command, returning its exit code."""
+    print(f"+ {' '.join(cmd)}")
+    return subprocess.call(cmd)
+
+
+def _manual_instructions(service_name, target):
+    print(
+        "\nTo install manually:\n"
+        f"  cp {service_name}.service {service_name}.timer {target}/\n"
+        f"  systemctl daemon-reload\n"
+        f"  systemctl enable --now {service_name}.timer"
+    )
+
+
+def _install(service_name):
+    """Offer to copy the units into place, reload systemd and enable the timer."""
+    units = [f"{service_name}.service", f"{service_name}.timer"]
+
+    user_scope = _prompt_yes_no(
+        "Install as a user unit (instead of system-wide)?", default=True
+    )
+    if user_scope:
+        target = USER_UNIT_DIR
+        sudo = []
+        systemctl = ["systemctl", "--user"]
+    else:
+        target = SYSTEM_UNIT_DIR
+        sudo = ["sudo"]
+        systemctl = ["sudo", "systemctl"]
+
+    if not _prompt_yes_no(f"Copy units into {target} now?", default=True):
+        _manual_instructions(service_name, target)
+        return
+
+    if not os.path.isdir(target):
+        if _prompt_yes_no(
+            f"Directory {target} does not exist. Create it?", default=True
+        ):
+            if _run(sudo + ["mkdir", "-p", target]) != 0:
+                print("Failed to create directory; aborting install.", file=sys.stderr)
+                return
+        else:
+            _manual_instructions(service_name, target)
+            return
+
+    for unit in units:
+        if _run(sudo + ["cp", unit, os.path.join(target, unit)]) != 0:
+            print(f"Failed to copy {unit}; aborting install.", file=sys.stderr)
+            return
+
+    _run(systemctl + ["daemon-reload"])
+
+    if _prompt_yes_no(f"Enable and start {service_name}.timer now?", default=True):
+        _run(systemctl + ["enable", "--now", f"{service_name}.timer"])
+
+
+def main():
+    if len(sys.argv) != 2:
+        print(f"Usage: {sys.argv[0]} <service name>", file=sys.stderr)
+        sys.exit(1)
+
+    service_name = sys.argv[1]
+
+    with open(f"{service_name}.service", "w") as f:
+        f.write(_render_service(service_name))
+    editor.edit(filename=f"{service_name}.service")
+    with open(f"{service_name}.timer", "w") as f:
+        f.write(_render_timer(service_name))
+    editor.edit(filename=f"{service_name}.timer")
+
+    if _prompt_yes_no(
+        f"\nGenerated {service_name}.service and {service_name}.timer.\n"
+        "Install them now?",
+        default=False,
+    ):
+        _install(service_name)
+
+
+if __name__ == "__main__":
+    main()