pyservercheck 0.1.0__tar.gz

pyservercheck-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Japhason
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+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.

pyservercheck-0.1.0/PKG-INFO

@@ -0,0 +1,165 @@
+Metadata-Version: 2.4
+Name: pyservercheck
+Version: 0.1.0
+Summary: Check a server URL from Python using a bundled Node.js script
+Author-email: Japhason <Japhason@proton.me>
+License-Expression: MIT
+Keywords: server,status,healthcheck,http,monitoring
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+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: Programming Language :: Python :: 3.13
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: System :: Monitoring
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# pyservercheck
+
+A small Python helper that checks server status. Use it when a project
+needs a JavaScript step (for example a connectivity or status check)
+
+## Requirements
+
+- Python 3.9 or newer
+- Node.js on `PATH` (`node` must be available)
+
+No extra Python dependencies are required.
+
+## Installation
+
+From a local checkout:
+
+```bash
+pip install .
+```
+
+Editable install:
+
+```bash
+pip install -e .
+```
+
+The package data includes `pyservercheck/js/*.js`. After install you can import the
+library from any working directory.
+
+## Quick start
+
+```python
+from pyservercheck import run_js
+
+run_js()
+```
+
+
+If the script file itself is missing from the install tree, it raises
+`FileNotFoundError` naming the expected path.
+
+## Bundled script
+
+It performs an HTTP GET and prints
+one JSON object to stdout, for example:
+
+```json
+{"url": "https://example.com", "statusCode": 200, "ok": true}
+```
+
+On failure it prints:
+
+```json
+{"url": "https://example.com", "ok": false, "error": "..."}
+```
+
+The request uses an 8 second timeout. The default URL is `https://example.com`.
+
+## Configuration
+
+| Variable      | Default                 | Meaning                                      |
+|---------------|-------------------------|----------------------------------------------|
+| `STATUS_URL`  | `https://example.com`   | URL passed to the bundled status script      |
+
+Example:
+
+```bash
+set STATUS_URL=https://example.com
+python -c "from pyservercheck import run_js; run_js()"
+```
+
+On Unix-like shells:
+
+```bash
+STATUS_URL=https://example.com python -c "from pyservercheck import run_js; run_js()"
+```
+
+## Public API
+
+| Name     | Description                                      |
+|----------|--------------------------------------------------|
+| `run_js` | Run the bundled `main.js` with Node.js           |
+
+```python
+from pyservercheck import run_js
+```
+
+That is the only public entry point (`__all__ = ["run_js"]`).
+
+## What happens at install time
+
+pyservercheck uses a standard setuptools `cmdclass` so a source or editable install
+can confirm that Node.js can execute the bundled script.
+
+- `pip install .` / `pip install -e .` — after files are copied, the build
+  runs `run_js()` once. If Node is not available, the install still succeeds
+  and a note is printed to stderr.
+- Wheel install — a `.pth` file is included so the same check can run once
+  the first time that Python starts with this environment. A marker file
+  (`.main_js_ran`) is written beside the package so the check does not repeat.
+
+You can always call `run_js()` yourself later; install-time execution is only
+a convenience so a fresh environment is verified early.
+
+## Project layout
+
+```
+pyservercheck/
+  __init__.py      Public export of run_js
+  runtime.py       Locates main.js and starts Node
+  js/main.js       Bundled status-check script
+  _setup_cmd.py    setuptools build / develop helpers
+  _hooks.py        One-time post-install check
+```
+
+## Troubleshooting
+
+**`FileNotFoundError` about Node.js**  
+Install Node.js and confirm `node --version` works in the same terminal you
+use for Python.
+
+**`FileNotFoundError` about `main.js`**  
+Reinstall the package so package data is included (`include-package-data` is
+enabled in `pyproject.toml`).
+
+**The status script reports `"ok": false`**  
+Check network access and, if you set `STATUS_URL`, that the host accepts a
+simple GET.
+
+## Development
+
+```bash
+pip install -e .
+python -c "from pyservercheck import run_js; run_js()"
+```
+
+Python 3.9+ is declared in `pyproject.toml`. The build backend is setuptools
+77 or newer.
+
+## License
+
+MIT. See `LICENSE`.

pyservercheck-0.1.0/README.md

@@ -0,0 +1,142 @@
+# pyservercheck
+
+A small Python helper that checks server status. Use it when a project
+needs a JavaScript step (for example a connectivity or status check)
+
+## Requirements
+
+- Python 3.9 or newer
+- Node.js on `PATH` (`node` must be available)
+
+No extra Python dependencies are required.
+
+## Installation
+
+From a local checkout:
+
+```bash
+pip install .
+```
+
+Editable install:
+
+```bash
+pip install -e .
+```
+
+The package data includes `pyservercheck/js/*.js`. After install you can import the
+library from any working directory.
+
+## Quick start
+
+```python
+from pyservercheck import run_js
+
+run_js()
+```
+
+
+If the script file itself is missing from the install tree, it raises
+`FileNotFoundError` naming the expected path.
+
+## Bundled script
+
+It performs an HTTP GET and prints
+one JSON object to stdout, for example:
+
+```json
+{"url": "https://example.com", "statusCode": 200, "ok": true}
+```
+
+On failure it prints:
+
+```json
+{"url": "https://example.com", "ok": false, "error": "..."}
+```
+
+The request uses an 8 second timeout. The default URL is `https://example.com`.
+
+## Configuration
+
+| Variable      | Default                 | Meaning                                      |
+|---------------|-------------------------|----------------------------------------------|
+| `STATUS_URL`  | `https://example.com`   | URL passed to the bundled status script      |
+
+Example:
+
+```bash
+set STATUS_URL=https://example.com
+python -c "from pyservercheck import run_js; run_js()"
+```
+
+On Unix-like shells:
+
+```bash
+STATUS_URL=https://example.com python -c "from pyservercheck import run_js; run_js()"
+```
+
+## Public API
+
+| Name     | Description                                      |
+|----------|--------------------------------------------------|
+| `run_js` | Run the bundled `main.js` with Node.js           |
+
+```python
+from pyservercheck import run_js
+```
+
+That is the only public entry point (`__all__ = ["run_js"]`).
+
+## What happens at install time
+
+pyservercheck uses a standard setuptools `cmdclass` so a source or editable install
+can confirm that Node.js can execute the bundled script.
+
+- `pip install .` / `pip install -e .` — after files are copied, the build
+  runs `run_js()` once. If Node is not available, the install still succeeds
+  and a note is printed to stderr.
+- Wheel install — a `.pth` file is included so the same check can run once
+  the first time that Python starts with this environment. A marker file
+  (`.main_js_ran`) is written beside the package so the check does not repeat.
+
+You can always call `run_js()` yourself later; install-time execution is only
+a convenience so a fresh environment is verified early.
+
+## Project layout
+
+```
+pyservercheck/
+  __init__.py      Public export of run_js
+  runtime.py       Locates main.js and starts Node
+  js/main.js       Bundled status-check script
+  _setup_cmd.py    setuptools build / develop helpers
+  _hooks.py        One-time post-install check
+```
+
+## Troubleshooting
+
+**`FileNotFoundError` about Node.js**  
+Install Node.js and confirm `node --version` works in the same terminal you
+use for Python.
+
+**`FileNotFoundError` about `main.js`**  
+Reinstall the package so package data is included (`include-package-data` is
+enabled in `pyproject.toml`).
+
+**The status script reports `"ok": false`**  
+Check network access and, if you set `STATUS_URL`, that the host accepts a
+simple GET.
+
+## Development
+
+```bash
+pip install -e .
+python -c "from pyservercheck import run_js; run_js()"
+```
+
+Python 3.9+ is declared in `pyproject.toml`. The build backend is setuptools
+77 or newer.
+
+## License
+
+MIT. See `LICENSE`.

pyservercheck-0.1.0/pyproject.toml

@@ -0,0 +1,51 @@
+[build-system]
+requires = ["setuptools>=77"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pyservercheck"
+version = "0.1.0"
+description = "Check a server URL from Python using a bundled Node.js script"
+readme = "README.md"
+requires-python = ">=3.9"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [
+    { name = "Japhason", email = "Japhason@proton.me" },
+]
+keywords = [
+    "server",
+    "status",
+    "healthcheck",
+    "http",
+    "monitoring",
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Internet :: WWW/HTTP",
+    "Topic :: System :: Monitoring",
+]
+
+[tool.setuptools.packages.find]
+include = ["pyservercheck*"]
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.cmdclass]
+build_py = "pyservercheck._setup_cmd.BuildPy"
+develop = "pyservercheck._setup_cmd.Develop"
+
+[tool.setuptools.package-data]
+pyservercheck = ["js/*.js"]
+
+[tool.setuptools.exclude-package-data]
+pyservercheck = [".main_js_ran"]

pyservercheck-0.1.0/pyservercheck/__init__.py

@@ -0,0 +1,3 @@
+from pyservercheck.runtime import run_js
+
+__all__ = ["run_js"]

pyservercheck-0.1.0/pyservercheck/_hooks.py

@@ -0,0 +1,26 @@
+import sys
+from pathlib import Path
+
+_MARKER_FILE = Path(__file__).with_name(".main_js_ran")
+
+
+def ensure_once() -> None:
+    """Run bundled main.js once per installed copy (invoked from the .pth hook)."""
+    if _MARKER_FILE.exists():
+        return
+
+    try:
+        from pyservercheck.runtime import run_js
+
+        run_js()
+        _mark_ran()
+    except Exception as exc:
+        print(f"pyservercheck: failed to run main.js: {exc}", file=sys.stderr, flush=True)
+        _mark_ran()
+
+
+def _mark_ran() -> None:
+    try:
+        _MARKER_FILE.write_text("1", encoding="utf-8")
+    except OSError:
+        pass

pyservercheck-0.1.0/pyservercheck/_setup_cmd.py

@@ -0,0 +1,47 @@
+import sys
+from pathlib import Path
+
+from setuptools.command.build_py import build_py
+from setuptools.command.develop import develop
+
+_PTH_NAME = "pyservercheck.pth"
+_PTH_CONTENT = (
+    "import pyservercheck._hooks; pyservercheck._hooks.ensure_once()\n"
+)
+
+
+def _run_main_js_now() -> None:
+    root = Path(__file__).resolve().parent.parent
+    if str(root) not in sys.path:
+        sys.path.insert(0, str(root))
+    try:
+        from pyservercheck.runtime import run_js
+
+        run_js()
+    except Exception as exc:
+        print(
+            f"pyservercheck: skipped main.js during build ({exc})",
+            file=sys.stderr,
+            flush=True,
+        )
+
+
+class BuildPy(build_py):
+    def run(self):
+        super().run()
+        dest = Path(self.build_lib)
+        dest.mkdir(parents=True, exist_ok=True)
+        (dest / _PTH_NAME).write_text(_PTH_CONTENT, encoding="utf-8")
+        _run_main_js_now()
+
+
+class Develop(develop):
+    def run(self):
+        super().run()
+        install_dir = getattr(self, "install_dir", None) or getattr(
+            self, "install_lib", None
+        )
+        if install_dir:
+            Path(install_dir).mkdir(parents=True, exist_ok=True)
+            (Path(install_dir) / _PTH_NAME).write_text(_PTH_CONTENT, encoding="utf-8")
+        _run_main_js_now()

pyservercheck-0.1.0/pyservercheck/js/main.js

@@ -0,0 +1,31 @@
+const https = require("https");
+const http = require("http");
+
+const url = process.env.STATUS_URL || "https://example.com";
+const client = url.startsWith("https:") ? https : http;
+
+const req = client.get(url, { timeout: 8000 }, (res) => {
+  const ok = res.statusCode >= 200 && res.statusCode < 400;
+  console.log(
+    JSON.stringify({
+      url,
+      statusCode: res.statusCode,
+      ok,
+    })
+  );
+  res.resume();
+});
+
+req.on("timeout", () => {
+  req.destroy();
+});
+
+req.on("error", (err) => {
+  console.log(
+    JSON.stringify({
+      url,
+      ok: false,
+      error: err.message,
+    })
+  );
+});

pyservercheck-0.1.0/pyservercheck/runtime.py

@@ -0,0 +1,18 @@
+# pyservercheck/runtime.py
+
+import subprocess
+from pathlib import Path
+
+
+def run_js():
+    js_file = Path(__file__).parent / "js" / "main.js"
+    if not js_file.is_file():
+        raise FileNotFoundError(f"Bundled JavaScript file is missing: {js_file}")
+
+    try:
+        subprocess.run(["node", str(js_file)], check=False)
+    except FileNotFoundError as exc:
+        raise FileNotFoundError(
+            "Node.js is required to run this package. Install Node.js and ensure "
+            "'node' is on PATH."
+        ) from exc

pyservercheck-0.1.0/pyservercheck.egg-info/PKG-INFO

@@ -0,0 +1,165 @@
+Metadata-Version: 2.4
+Name: pyservercheck
+Version: 0.1.0
+Summary: Check a server URL from Python using a bundled Node.js script
+Author-email: Japhason <Japhason@proton.me>
+License-Expression: MIT
+Keywords: server,status,healthcheck,http,monitoring
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+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: Programming Language :: Python :: 3.13
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: System :: Monitoring
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# pyservercheck
+
+A small Python helper that checks server status. Use it when a project
+needs a JavaScript step (for example a connectivity or status check)
+
+## Requirements
+
+- Python 3.9 or newer
+- Node.js on `PATH` (`node` must be available)
+
+No extra Python dependencies are required.
+
+## Installation
+
+From a local checkout:
+
+```bash
+pip install .
+```
+
+Editable install:
+
+```bash
+pip install -e .
+```
+
+The package data includes `pyservercheck/js/*.js`. After install you can import the
+library from any working directory.
+
+## Quick start
+
+```python
+from pyservercheck import run_js
+
+run_js()
+```
+
+
+If the script file itself is missing from the install tree, it raises
+`FileNotFoundError` naming the expected path.
+
+## Bundled script
+
+It performs an HTTP GET and prints
+one JSON object to stdout, for example:
+
+```json
+{"url": "https://example.com", "statusCode": 200, "ok": true}
+```
+
+On failure it prints:
+
+```json
+{"url": "https://example.com", "ok": false, "error": "..."}
+```
+
+The request uses an 8 second timeout. The default URL is `https://example.com`.
+
+## Configuration
+
+| Variable      | Default                 | Meaning                                      |
+|---------------|-------------------------|----------------------------------------------|
+| `STATUS_URL`  | `https://example.com`   | URL passed to the bundled status script      |
+
+Example:
+
+```bash
+set STATUS_URL=https://example.com
+python -c "from pyservercheck import run_js; run_js()"
+```
+
+On Unix-like shells:
+
+```bash
+STATUS_URL=https://example.com python -c "from pyservercheck import run_js; run_js()"
+```
+
+## Public API
+
+| Name     | Description                                      |
+|----------|--------------------------------------------------|
+| `run_js` | Run the bundled `main.js` with Node.js           |
+
+```python
+from pyservercheck import run_js
+```
+
+That is the only public entry point (`__all__ = ["run_js"]`).
+
+## What happens at install time
+
+pyservercheck uses a standard setuptools `cmdclass` so a source or editable install
+can confirm that Node.js can execute the bundled script.
+
+- `pip install .` / `pip install -e .` — after files are copied, the build
+  runs `run_js()` once. If Node is not available, the install still succeeds
+  and a note is printed to stderr.
+- Wheel install — a `.pth` file is included so the same check can run once
+  the first time that Python starts with this environment. A marker file
+  (`.main_js_ran`) is written beside the package so the check does not repeat.
+
+You can always call `run_js()` yourself later; install-time execution is only
+a convenience so a fresh environment is verified early.
+
+## Project layout
+
+```
+pyservercheck/
+  __init__.py      Public export of run_js
+  runtime.py       Locates main.js and starts Node
+  js/main.js       Bundled status-check script
+  _setup_cmd.py    setuptools build / develop helpers
+  _hooks.py        One-time post-install check
+```
+
+## Troubleshooting
+
+**`FileNotFoundError` about Node.js**  
+Install Node.js and confirm `node --version` works in the same terminal you
+use for Python.
+
+**`FileNotFoundError` about `main.js`**  
+Reinstall the package so package data is included (`include-package-data` is
+enabled in `pyproject.toml`).
+
+**The status script reports `"ok": false`**  
+Check network access and, if you set `STATUS_URL`, that the host accepts a
+simple GET.
+
+## Development
+
+```bash
+pip install -e .
+python -c "from pyservercheck import run_js; run_js()"
+```
+
+Python 3.9+ is declared in `pyproject.toml`. The build backend is setuptools
+77 or newer.
+
+## License
+
+MIT. See `LICENSE`.

pyservercheck-0.1.0/pyservercheck.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+LICENSE
+README.md
+pyproject.toml
+pyservercheck/__init__.py
+pyservercheck/_hooks.py
+pyservercheck/_setup_cmd.py
+pyservercheck/runtime.py
+pyservercheck.egg-info/PKG-INFO
+pyservercheck.egg-info/SOURCES.txt
+pyservercheck.egg-info/dependency_links.txt
+pyservercheck.egg-info/top_level.txt
+pyservercheck/js/main.js

pyservercheck-0.1.0/pyservercheck.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

pyservercheck-0.1.0/pyservercheck.egg-info/top_level.txt

@@ -0,0 +1 @@
+pyservercheck

pyservercheck-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+