supervice 0.1.0__tar.gz

supervice-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 Farshid Ashouri
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

supervice-0.1.0/PKG-INFO

@@ -0,0 +1,300 @@
+Metadata-Version: 2.4
+Name: supervice
+Version: 0.1.0
+Summary: A modern, async process supervisor for Unix-like systems. Zero dependencies.
+Author: Farshid Ashouri
+License-Expression: Apache-2.0
+Project-URL: Documentation, https://supervice.readthedocs.io
+Project-URL: Repository, https://github.com/rodmena-limited/supervice
+Project-URL: Issues, https://github.com/rodmena-limited/supervice/issues
+Project-URL: Changelog, https://supervice.readthedocs.io/en/latest/changelog.html
+Keywords: supervisor,process-manager,daemon,asyncio,process-control
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: No Input/Output (Daemon)
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: MacOS
+Classifier: Programming Language :: Python :: 3
+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: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: System :: Boot
+Classifier: Topic :: System :: Monitoring
+Classifier: Topic :: System :: Systems Administration
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: docs
+Requires-Dist: sphinx>=7.0; extra == "docs"
+Requires-Dist: furo>=2024.0; extra == "docs"
+Requires-Dist: myst-parser>=3.0; extra == "docs"
+Requires-Dist: sphinx-copybutton>=0.5; extra == "docs"
+Provides-Extra: dev
+Requires-Dist: mypy>=1.0; extra == "dev"
+Requires-Dist: ruff>=0.4; extra == "dev"
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.23; extra == "dev"
+Dynamic: license-file
+
+# Supervice
+
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
+[![Python 3.10+](https://img.shields.io/badge/python-3.10%2B-blue.svg)](https://www.python.org/downloads/)
+[![Code style: ruff](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://github.com/astral-sh/ruff)
+[![Type checked: mypy](https://img.shields.io/badge/type%20checked-mypy--strict-blue.svg)](https://mypy-lang.org/)
+[![Documentation](https://readthedocs.org/projects/supervice/badge/?version=latest)](https://supervice.readthedocs.io)
+
+A modern, lightweight, and fully async process supervisor for Unix-like systems.
+**Zero dependencies. Pure Python. Production-ready.**
+
+Supervice manages long-running processes with automatic restart, health checking,
+process grouping, hot config reload, and a Unix socket RPC interface — all built
+on Python's `asyncio` with no external packages.
+
+---
+
+## Features
+
+- **Async-first** — Built entirely on `asyncio` for efficient I/O multiplexing
+- **Zero dependencies** — Pure Python stdlib; nothing to install beyond Python 3.10+
+- **Process groups** — Organize related processes and control them as a unit
+- **Health checks** — TCP connectivity and script-based health monitoring with auto-restart
+- **Hot reload** — Add/remove programs without restarting the daemon (`supervicectl reload`)
+- **Daemon mode** — Proper double-fork daemonization with PID file locking
+- **Graceful shutdown** — SIGTERM/SIGINT triggers orderly stop of all child processes
+- **Process group kill** — Stops entire process trees, not just the main PID
+- **Log rotation** — Built-in `RotatingFileHandler` with configurable size and backup count
+- **Uptime tracking** — Per-process wall-clock uptime displayed in status output
+- **Retry with backoff** — Configurable start retries with automatic FATAL state on exhaustion
+- **User switching** — Run processes as a specific user (requires root)
+- **Type-safe** — Fully type-hinted, passes `mypy --strict`
+
+## Installation
+
+**Requirements:** Python 3.10+ on a Unix-like OS (Linux, macOS).
+
+```bash
+# From source
+git clone https://github.com/yourusername/supervice.git
+cd supervice
+pip install .
+
+# Development install (includes docs dependencies)
+pip install -e ".[docs]"
+```
+
+## Quick Start
+
+### 1. Create a configuration file
+
+```ini
+# supervisord.conf
+[supervice]
+loglevel = INFO
+logfile = supervice.log
+pidfile = supervice.pid
+
+[program:webapp]
+command = python3 -u app.py
+autostart = true
+autorestart = true
+stdout_logfile = webapp.log
+stderr_logfile = webapp_err.log
+
+[program:worker]
+command = python3 -u worker.py
+numprocs = 4
+autostart = true
+autorestart = true
+stdout_logfile = worker_%(process_num)s.log
+stderr_logfile = worker_err_%(process_num)s.log
+```
+
+### 2. Start the daemon
+
+```bash
+# Foreground (development)
+supervice -c supervisord.conf -n
+
+# Background (production — default)
+supervice -c supervisord.conf
+```
+
+### 3. Control processes
+
+```bash
+# Check status
+supervicectl status
+
+# Output:
+# NAME                 STATE      PID        UPTIME
+# --------------------------------------------------------
+# webapp               RUNNING    12345      1:23:45
+# worker:00            RUNNING    12346      1:23:44
+# worker:01            RUNNING    12347      1:23:44
+# worker:02            RUNNING    12348      1:23:44
+# worker:03            RUNNING    12349      1:23:44
+
+# Start / stop / restart individual processes
+supervicectl stop worker:00
+supervicectl start worker:00
+supervicectl restart worker:00
+supervicectl restart worker:00 --force   # SIGKILL instead of graceful
+
+# Group operations
+supervicectl stopgroup workers
+supervicectl startgroup workers
+
+# Hot reload (add/remove programs without restart)
+supervicectl reload
+
+# Use a custom socket path
+supervicectl -s /var/run/supervice.sock status
+```
+
+## Configuration Reference
+
+### `[supervice]` — Global settings
+
+| Option | Default | Description |
+|--------|---------|-------------|
+| `logfile` | `supervice.log` | Path to the daemon log file |
+| `loglevel` | `INFO` | Log level: `DEBUG`, `INFO`, `WARNING`, `ERROR`, `CRITICAL` |
+| `pidfile` | `supervice.pid` | Path to the PID/lock file |
+| `socket` | `/tmp/supervice.sock` | Unix socket path for RPC |
+| `shutdown_timeout` | `30` | Seconds to wait for graceful shutdown |
+| `log_maxbytes` | `52428800` | Max log file size before rotation (bytes, 0 = no rotation) |
+| `log_backups` | `10` | Number of rotated log backup files to keep |
+
+### `[program:NAME]` — Process definitions
+
+| Option | Default | Description |
+|--------|---------|-------------|
+| `command` | *(required)* | Command to execute (supports shell-style quoting) |
+| `numprocs` | `1` | Number of instances to run (creates `NAME:00`, `NAME:01`, ...) |
+| `autostart` | `true` | Start automatically when daemon starts |
+| `autorestart` | `true` | Restart automatically when process exits |
+| `startsecs` | `1` | Seconds a process must run to be considered successfully started |
+| `startretries` | `3` | Max consecutive start attempts before entering FATAL state |
+| `stopsignal` | `TERM` | Signal to send when stopping (`TERM`, `INT`, `QUIT`, `KILL`, etc.) |
+| `stopwaitsecs` | `10` | Seconds to wait after stop signal before sending SIGKILL |
+| `stdout_logfile` | *(none)* | File for stdout (supports `%(process_num)s` substitution) |
+| `stderr_logfile` | *(none)* | File for stderr (supports `%(process_num)s` substitution) |
+| `environment` | *(none)* | Environment variables: `KEY=VAL,KEY2="val with,comma"` |
+| `directory` | *(none)* | Working directory for the process |
+| `user` | *(none)* | Run as this user (requires root privileges) |
+
+### `[group:NAME]` — Process groups
+
+| Option | Default | Description |
+|--------|---------|-------------|
+| `programs` | *(required)* | Comma-separated list of program names |
+
+### Health check options (per program)
+
+| Option | Default | Description |
+|--------|---------|-------------|
+| `healthcheck_type` | `none` | Health check type: `none`, `tcp`, `script` |
+| `healthcheck_interval` | `30` | Seconds between health checks |
+| `healthcheck_timeout` | `10` | Seconds to wait for health check response |
+| `healthcheck_retries` | `3` | Consecutive failures before marking unhealthy |
+| `healthcheck_start_period` | `10` | Seconds to wait before starting health checks |
+| `healthcheck_port` | *(none)* | TCP port to check (required for `tcp` type) |
+| `healthcheck_host` | `127.0.0.1` | TCP host to check |
+| `healthcheck_command` | *(none)* | Script to run (required for `script` type) |
+
+**Example with health checks:**
+
+```ini
+[program:api]
+command = python3 -u api_server.py
+autostart = true
+autorestart = true
+healthcheck_type = tcp
+healthcheck_port = 8080
+healthcheck_interval = 15
+healthcheck_retries = 3
+healthcheck_start_period = 5
+```
+
+## Process States
+
+```
+STOPPED ──┐
+EXITED  ──┼──> STARTING ──> RUNNING ──> STOPPING ──> STOPPED
+FATAL   ──┤                    │                        │
+BACKOFF ──┘                    │                     EXITED
+                               ▼
+                           UNHEALTHY (health check failures)
+                               │
+                               ▼
+                         auto-restart (if autorestart=true)
+```
+
+| State | Description |
+|-------|-------------|
+| `STOPPED` | Process is not running (initial or manually stopped) |
+| `STARTING` | Process has been spawned, waiting for confirmation |
+| `RUNNING` | Process is running and healthy |
+| `BACKOFF` | Process exited too quickly, waiting before retry |
+| `STOPPING` | Stop signal sent, waiting for process to exit |
+| `EXITED` | Process has exited (normally or abnormally) |
+| `FATAL` | Process failed to start after exhausting retries |
+| `UNHEALTHY` | Process is running but health checks are failing |
+
+## Architecture
+
+```
+┌─────────────────────────────────────────────────┐
+│                   supervice                      │
+│                                                  │
+│  ┌──────────┐    ┌───────────┐    ┌──────────┐  │
+│  │  Config   │───▶│ Supervisor │───▶│ Process  │  │
+│  │  Parser   │    │   (core)   │    │ Manager  │  │
+│  └──────────┘    └─────┬─────┘    └────┬─────┘  │
+│                        │               │         │
+│                   ┌────▼────┐    ┌─────▼─────┐  │
+│                   │   RPC    │    │  EventBus  │  │
+│                   │  Server  │    │  (pub/sub) │  │
+│                   └────┬────┘    └───────────┘  │
+│                        │                         │
+└────────────────────────┼─────────────────────────┘
+                         │ Unix Socket
+                    ┌────▼────┐
+                    │supervice│
+                    │  ctl    │
+                    └─────────┘
+```
+
+## Documentation
+
+Full documentation is available at [supervice.readthedocs.io](https://supervice.readthedocs.io).
+
+## Development
+
+```bash
+# Run tests
+python3 -m pytest tests/ -v
+
+# Type checking (strict mode)
+mypy --strict supervice/
+
+# Linting
+ruff check supervice/
+
+# Formatting
+ruff format supervice/
+
+# Build documentation locally
+pip install -e ".[docs]"
+cd docs && make html
+```
+
+## License
+
+Apache License 2.0 — see [LICENSE](LICENSE) for details.