cronipy 0.1.0__tar.gz

cronipy-0.1.0/PKG-INFO

@@ -0,0 +1,69 @@
+Metadata-Version: 2.3
+Name: cronipy
+Version: 0.1.0
+Summary: Add your description here
+Author: lantonic
+Author-email: lantonic <luka.olegsson@gmail.com>
+Requires-Dist: cyclopts>=5.3.2
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown
+
+# cronipy
+
+`cronipy` turns Python functions into cron jobs. You decorate a function with a schedule, run one command, and cronipy writes the crontab entries for you. The package is in early development, and the interface can change.
+
+## Installation
+
+```bash
+pip install cronipy
+```
+
+## Usage
+
+Define your jobs in a module of your package, e.g. `mypackage.tasks`:
+
+```python
+from cronipy import Cron
+
+cron = Cron()
+
+@cron.task("*/5 * * * *")
+def do_something_every_five_minutes():
+    ...
+```
+
+Then install the jobs into your crontab:
+
+```python
+cron.install()
+```
+
+or from a shell, install jobs from all `Cron` objects in the specified module:
+
+```bash
+$ cronipy install mypackage.tasks
+```
+
+`cronipy` adds one line per decorated function into the current user's `crontab`. Function output is logged in `logs/<function name>.log`.
+
+## Options
+
+You can pass these arguments to `Cron`:
+
+- `dry_run`: when true, a job prints its name and does nothing.
+- `env`: a dictionary of environment variables added to every crontab line.
+- `log_dir`: where the log files go, `./logs` by default.
+- `work_dir`: the directory each job runs in, `./` by default.
+- `python`: the interpreter the jobs use, the one that runs cronipy by default.
+
+## Development
+
+This repository uses [uv](https://docs.astral.sh/uv/). Set up a development environment with `uv sync`, and run the checks with `uv run pytest`.
+
+## Roadmap
+
+- [ ] Enable autodiscovery of modules containing Cron objects.
+- [ ] Enable compatibility with single-file modules.
+
+## License
+[BSD 3-Clause](./LICENSE.txt) 

cronipy-0.1.0/README.md

@@ -0,0 +1,59 @@
+# cronipy
+
+`cronipy` turns Python functions into cron jobs. You decorate a function with a schedule, run one command, and cronipy writes the crontab entries for you. The package is in early development, and the interface can change.
+
+## Installation
+
+```bash
+pip install cronipy
+```
+
+## Usage
+
+Define your jobs in a module of your package, e.g. `mypackage.tasks`:
+
+```python
+from cronipy import Cron
+
+cron = Cron()
+
+@cron.task("*/5 * * * *")
+def do_something_every_five_minutes():
+    ...
+```
+
+Then install the jobs into your crontab:
+
+```python
+cron.install()
+```
+
+or from a shell, install jobs from all `Cron` objects in the specified module:
+
+```bash
+$ cronipy install mypackage.tasks
+```
+
+`cronipy` adds one line per decorated function into the current user's `crontab`. Function output is logged in `logs/<function name>.log`.
+
+## Options
+
+You can pass these arguments to `Cron`:
+
+- `dry_run`: when true, a job prints its name and does nothing.
+- `env`: a dictionary of environment variables added to every crontab line.
+- `log_dir`: where the log files go, `./logs` by default.
+- `work_dir`: the directory each job runs in, `./` by default.
+- `python`: the interpreter the jobs use, the one that runs cronipy by default.
+
+## Development
+
+This repository uses [uv](https://docs.astral.sh/uv/). Set up a development environment with `uv sync`, and run the checks with `uv run pytest`.
+
+## Roadmap
+
+- [ ] Enable autodiscovery of modules containing Cron objects.
+- [ ] Enable compatibility with single-file modules.
+
+## License
+[BSD 3-Clause](./LICENSE.txt) 

cronipy-0.1.0/cronipy/__init__.py

@@ -0,0 +1,102 @@
+import inspect
+import json
+import subprocess
+import sys
+from datetime import datetime
+from functools import wraps
+from pathlib import Path
+from types import FrameType
+from typing import Any, Callable
+
+from cyclopts import App
+
+__version__ = "0.1.0"
+
+
+class Cron:
+    def __init__(
+        self,
+        dry_run: bool = False,
+        env: dict | None = None,
+        log_dir: Path | None = None,
+        work_dir: Path | None = None,
+        python: str = sys.executable,
+    ):
+        self.dry_run = dry_run
+        self.env = env or {}
+        self.log_dir = log_dir or Path("./logs")
+        self.work_dir = work_dir or Path("./")
+        self.tasks: list[tuple[Callable, str, dict]] = []
+        self.app = App()
+        self.app.command(self.install, name="install-crontab")
+        self.python = python
+
+        frame = inspect.currentframe().f_back
+        while frame and frame.f_globals["__name__"].startswith("importlib."):
+            frame = frame.f_back
+        # TODO: make this work for calling from single file scripts
+        # where module becomes __main__
+        self.module = frame.f_globals["__name__"]
+        if self.module == "__main__" and frame.f_globals["__spec__"]:
+            self.module = frame.f_globals["__spec__"].name.strip(".__main__")
+        self.frame = frame
+
+    @property
+    def name(self) -> str | None:
+        for k, v in [*self.frame.f_globals.items()]:
+            if isinstance(v, Cron):
+                return k
+
+    def __call__(self):
+        self.app()
+
+    def install(self, replace_existing: bool = False):
+        print(f"environment vars:\n\n{json.dumps(self.env, indent=2)}")
+
+        self.log_dir.mkdir(exist_ok=True, parents=True)
+
+        if replace_existing:
+            subprocess.run("crontab -r", shell=True, check=True)
+
+        for task, crontab, env in self.tasks:
+            self._cronify(task, crontab, env)
+
+    def _command(self, func: Callable) -> Callable:
+        def wrapped(*args, **kwargs) -> Any:
+            print(f"[{datetime.now().isoformat()}]: {func.__name__}", flush=True)
+
+            if self.dry_run:
+                return
+
+            func(*args, **kwargs)
+
+        return wrapped
+
+    def task(self, crontab: str, env: dict | None = None) -> Callable:
+        def _task(func):
+            self.tasks.append((func, crontab, env or {}))
+            self.app.command(self._command(func), name=func.__name__)
+
+            @wraps(func)
+            def wrapped(*args, **kwargs) -> Any:
+                return func(*args, **kwargs)
+
+            return wrapped
+
+        return _task
+
+    def _cronify(self, func: Callable, crontab: str, env: dict | None = None):
+        name = func.__name__
+        env = env or {}
+        _env = " ".join((f"{k}={v}" for k, v in (self.env | env).items()))
+        _call = (
+            f"{_env} {self.python} -c"
+            f' \\"from {self.module} import {self.name}; {self.name}()\\" {name} >>'
+            f" {self.log_dir.absolute()}/{name}.log 2>&1"
+        )
+        _cmd = (
+            f'(crontab -l 2>/dev/null; echo "{crontab}'
+            f" cd {self.work_dir.absolute()}"
+            f' && {_env} {_call}") | crontab -'
+        )
+        subprocess.run(_cmd, shell=True, check=True)

cronipy-0.1.0/cronipy/__main__.py

@@ -0,0 +1,2 @@
+if __name__ == "__main__":
+    print("hi")

cronipy-0.1.0/cronipy/cli.py

@@ -0,0 +1,18 @@
+import cyclopts
+
+from . import Cron
+
+
+def main():
+    app = cyclopts.App()
+
+    @app.command
+    def install(module: str):
+        exec(f"""
+import {module} as mod
+for obj in mod.__dict__.values():
+    if isinstance(obj, Cron):
+        obj.install()
+""")
+
+    app()

cronipy-0.1.0/pyproject.toml

@@ -0,0 +1,38 @@
+[project]
+name = "cronipy"
+version = "0.1.0"
+description = "Add your description here"
+readme = "README.md"
+requires-python = ">=3.14"
+dependencies = ["cyclopts>=5.3.2"]
+
+[[project.authors]]
+name = "lantonic"
+email = "luka.olegsson@gmail.com"
+
+[project.scripts]
+cronipy = "cronipy.cli:main"
+
+[dependency-groups]
+dev = [
+    "pytest>=9.0.3",
+    "pytest-ruff>=0.5",
+    "ruff>=0.17.3",
+]
+
+[tool.ruff]
+target-version = "py314"
+
+[tool.ruff.lint]
+ignore = [
+    "F401",
+    "S102",
+]
+
+[tool.uv.build-backend]
+module-name = "cronipy"
+module-root = ""
+
+[build-system]
+requires = ["uv_build>=0.13.5,<0.14.0"]
+build-backend = "uv_build"

cronipy-0.1.0/pyproject.toml.orig

@@ -0,0 +1,36 @@
+[project]
+name = "cronipy"
+version = "0.1.0"
+description = "Add your description here"
+readme = "README.md"
+authors = [
+    { name = "lantonic", email = "luka.olegsson@gmail.com" }
+]
+requires-python = ">=3.14"
+dependencies = [
+    "cyclopts>=5.3.2",
+]
+
+[project.scripts]
+cronipy = "cronipy.cli:main"
+
+[dependency-groups]
+dev = [
+  "pytest>=9.0.3",
+  "pytest-ruff>=0.5",
+  "ruff>=0.17.3",
+]
+
+[tool.ruff]
+target-version = "py314"
+
+[tool.ruff.lint]
+ignore = ["F401", "S102"]
+
+[build-system]
+requires = ["uv_build>=0.13.5,<0.14.0"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = "cronipy"
+module-root = ""