rpacore 0.1.0__tar.gz

rpacore-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 [yyyy] [name of copyright owner]
+
+   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.

rpacore-0.1.0/NOTICE

@@ -0,0 +1,4 @@
+RPA Core
+Copyright 2026 Renato Moselli
+
+This product includes software developed for the RPA Core project.

rpacore-0.1.0/PKG-INFO

@@ -0,0 +1,427 @@
+Metadata-Version: 2.4
+Name: rpacore
+Version: 0.1.0
+Summary: RPA Core — deterministic, stateful RPA in Python
+Author: Renato Moselli
+License: Apache-2.0
+Project-URL: Homepage, https://rpacore.dev
+Project-URL: Documentation, https://github.com/renatomoselli/rpacore/tree/main/docs
+Project-URL: Repository, https://github.com/renatomoselli/rpacore
+Project-URL: Issues, https://github.com/renatomoselli/rpacore/issues
+Project-URL: Security, https://github.com/renatomoselli/rpacore/security/advisories/new
+Keywords: rpa,automation,workflow,enterprise
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Provides-Extra: dev
+Requires-Dist: pytest>=8.1.1; extra == "dev"
+Requires-Dist: build>=1.0; extra == "dev"
+Requires-Dist: twine>=5.1.0; extra == "dev"
+Requires-Dist: wheel>=0.46.2; extra == "dev"
+Provides-Extra: screenshots
+Requires-Dist: mss>=9.0; extra == "screenshots"
+Provides-Extra: keyring
+Requires-Dist: keyring; extra == "keyring"
+Dynamic: license-file
+
+# RPA Core
+
+Deterministic, stateful RPA in Python for code-first enterprise automation.
+
+Requires Python 3.11+.
+
+## Package Name
+
+The public project name is **RPA Core**. The package, import path, and CLI
+command are `rpacore`.
+
+## What Is RPA Core?
+
+RPA Core is a pip-installable Python library for building reliable, auditable
+robotic process automations. Define your skills, wire them into a transaction,
+and the framework handles execution order, retry logic, persistence, logging,
+queues, reports, credentials, and notifications.
+
+The long-term product direction is:
+
+> AI-assisted development, deterministic execution.
+
+That means RPA Core should be friendly to humans and AI coding agents, but the
+runtime remains deterministic. There are no runtime AI dependencies.
+
+Core traits:
+
+- **Deterministic execution**: predictable behavior, no hidden runtime magic.
+- **Stateful transactions**: every skill's status is tracked and persisted.
+- **Idempotent retries**: resume from failure and re-run only failed work.
+- **Explicit exceptions**: business rule failures and system failures are
+  classified separately.
+- **Structured logging**: text or JSON output through stdlib logging.
+- **TOML configuration**: externalized settings with simple defaults.
+- **SQLite persistence**: local transaction history without a service.
+- **Queue processing**: SQLite-backed queue with atomic item claiming.
+- **Reports and notifications**: text/HTML reports, SMTP email, and webhooks.
+
+## Installation
+
+```bash
+pip install rpacore
+```
+
+For complete documentation, start at [docs/README.md](docs/README.md). See
+[CHANGELOG.md](CHANGELOG.md) for the v0.1.0 compatibility baseline. For
+maintainer validation and release scripts, see [scripts/](scripts/); these
+scripts are intentionally separate from the runtime package.
+
+Community and release-readiness routes:
+
+- [Security Policy](SECURITY.md)
+- [Contributing](CONTRIBUTING.md)
+- [Support](SUPPORT.md)
+- [Code of Conduct](CODE_OF_CONDUCT.md)
+- [Maintainers](MAINTAINERS.md)
+- [Governance and Release Process](docs/governance.md)
+
+## Quick Start
+
+```python
+from rpacore import (
+    Engine,
+    ProcessContext,
+    Transaction,
+    configure_logger,
+    load_config,
+    save_transaction,
+)
+
+from my_skills import FetchRecord, ProcessRecord, WriteOutput
+
+
+config = load_config("config.toml")
+configure_logger(level=config["log_level"], fmt=config["log_format"])
+
+tx = Transaction(reference="my-automation")
+tx.skills = [
+    FetchRecord(
+        name="fetch_record",
+        execution_order=1,
+        arguments={"record_id": "ABC-001"},
+    ),
+    ProcessRecord(name="process_record", execution_order=2),
+    WriteOutput(name="write_output", execution_order=3),
+]
+
+ctx = ProcessContext(transaction=tx, config=config)
+Engine(
+    max_retries=config["max_retries"],
+    retry_delay=config["retry_delay"],
+    retry_backoff=config["retry_backoff"],
+).run(
+    ctx,
+    checkpoint=lambda transaction: save_transaction(
+        transaction,
+        db_path=config["transaction_db_path"],
+    ),
+)
+```
+
+## CLI
+
+Create a new project scaffold:
+
+```bash
+rpacore init my_project
+cd my_project
+rpacore run
+```
+
+`rpacore init <project_name>` creates a normal Python project with
+`pyproject.toml`, `rpacore.toml`, `config.toml`, `main.py`, a `skills/` package,
+a pytest skill test, and `.gitignore`. Skill tests use normal pytest with
+plain skill instances and `ProcessContext`; see [Testing RPA Core Skills](docs/testing.md).
+
+`rpacore run` discovers `rpacore.toml` from the current directory, resolves the
+declared `module:callable` entrypoint, and invokes it. The CLI does not build
+skills, transactions, config, or persistence automatically; that wiring remains
+in project Python code.
+
+Inspect persisted local transactions:
+
+```bash
+rpacore transaction list
+rpacore transaction list --json
+rpacore transaction show <transaction_id>
+rpacore transaction show <transaction_id> --json
+rpacore transaction export --format json
+rpacore transaction export --format ndjson
+```
+
+Transaction inspection uses `[storage].transaction_db_path` from `rpacore.toml`
+by default. Pass `--db path/to/rpacore.db` to inspect a specific database.
+`--db` paths are resolved relative to the current working directory; manifest
+storage paths are resolved relative to `rpacore.toml`. `transaction list`
+returns the latest 100 transactions by default; pass `--limit N` to choose a
+different cap. Human output is intended for operators; `--json` writes parseable
+JSON to stdout with diagnostics only on stderr. Transaction inspection JSON uses
+`schema_version = 1` and embeds the canonical transaction record with
+`transaction_format_version = 1`.
+
+Transaction export writes portable machine-readable records for all persisted
+transactions. JSON export uses an envelope with `export_format_version = 1`,
+`framework_version`, `exported_at`, and `transactions`. NDJSON export writes one
+record per line with `export_format_version = 1` on each record.
+
+Machine-readable transaction records include user-supplied state, metadata,
+skill arguments, exception messages, and artifact metadata. These fields can
+contain sensitive business data. They never include resources, config,
+credentials, or artifact file contents. Webhook notifications preserve their
+compact payload shape by default while including report metadata and artifact
+records. Set
+`[notification.webhook].include_transaction = true` to include the canonical
+transaction record in the webhook JSON payload.
+
+Webhook URLs must use `http` or `https`. Local, private, loopback, and
+link-local hosts are allowed because webhook endpoints are trusted operator
+configuration in local automation deployments. Treat webhook config as
+sensitive: outbound requests can still reach internal services. The stdlib URL
+open timeout bounds socket operations after resolution starts, but it does not
+fully control operating-system DNS resolution latency.
+
+Email notifications attach screenshots referenced by exception reports only
+when `[notification.email].attach_screenshots` is true, which is the default.
+Missing or unreadable screenshot files are skipped; report and notification
+payloads include artifact records and paths, not artifact file contents.
+
+Set `log_format = "json"` and pass it to `configure_logger(..., fmt=...)` for
+line-delimited JSON logs. Each JSON log line contains `log_format_version`,
+UTC `timestamp`, `event`, `level`, and `message`, plus sanitized event fields.
+
+Exit behavior is stable across platforms:
+
+- entrypoint returns `None`: exit `0`
+- entrypoint returns an integer from `0` through `255`: propagate it
+- entrypoint or framework execution raises: exit `1` with diagnostics on stderr
+- CLI usage errors, invalid manifests, entrypoint-resolution errors, or invalid
+  return values: exit `2`
+
+`rpacore version` prints the installed framework version.
+
+## Writing a Skill
+
+```python
+from rpacore import BusinessException, ProcessContext, Skill
+
+
+class FetchRecord(Skill):
+    def execute(self, ctx: ProcessContext) -> None:
+        record_id = self.arguments.get("record_id")
+        if not record_id:
+            raise BusinessException(
+                message="record_id is required",
+                action="FetchRecord",
+            )
+
+        # Fetch and store durable state for later skills.
+        ctx.state["record"] = {"id": record_id}
+```
+
+## Project Structure
+
+```text
+rpacore/              # Framework core
+  __init__.py      # Public API re-exports
+  exceptions.py    # BusinessException, SystemException
+  status.py        # Status enum
+  skill.py         # Skill base class
+  transaction.py   # Transaction model
+  engine.py        # Execution engine
+  persistence.py   # SQLite persistence
+  logger.py        # Logging helpers
+  config.py        # Configuration loader
+  context.py       # ProcessContext
+  credentials.py   # Credential providers
+  queue.py         # SqliteQueue, QueueProvider
+  runner.py        # run_queue_loop
+  report.py        # Report generation and rendering
+  notify.py        # Email and webhook notifications
+```
+
+User automations should live outside `rpacore/`, usually in their own repository
+with a `skills/` package and a small `main.py` wiring layer.
+
+## Execution Model
+
+```text
+main.py
+  load_config()
+  configure_logger()
+  create Transaction
+  attach ordered Skills
+  create ProcessContext
+  Engine.run(ctx, checkpoint=save_transaction)
+  generate report / dispatch notifications
+```
+
+Transaction lifecycle:
+
+```text
+PENDING -> IN_PROGRESS -> SUCCESSFUL
+                       -> FAILED
+```
+
+`Engine.run()` validates transaction wiring before any skill runs. Transaction
+references and skill names must be non-empty, skill names must be unique within
+the transaction, and skill execution orders must be unique positive integers.
+Malformed wiring raises `ExecutionValidationError`, marks the transaction
+`FAILED`, and should be treated as a permanent configuration or code issue, not
+as a retryable runtime failure. The same validation applies to loaded
+transactions before resume, so persisted malformed skill wiring must be fixed
+rather than silently re-run.
+
+Persistence is written by user wiring through `save_transaction()`. For strict
+crash boundaries, pass that persistence call as `Engine.run(checkpoint=...)`;
+the engine checkpoints after each transaction or skill state transition. Without
+a checkpoint callback, user code may still save only after `Engine.run()`
+returns. Loading a persisted transaction resets any `IN_PROGRESS` transaction or
+skill to `FAILED`.
+
+## Configuration
+
+Create a `rpacore.toml` in your project to declare the Python entrypoint and
+transaction storage:
+
+```toml
+[project]
+entrypoint = "main:main"
+
+[storage]
+transaction_db_path = "rpacore.db"
+```
+
+`rpacore.toml` is intentionally small. Skill construction and transaction wiring
+stay in Python; the manifest does not define pipelines or automatic skill
+discovery. See `docs/project-manifest.md` for the full schema.
+
+When both `rpacore.toml` and `config.toml` are present, the value passed to the
+runner or storage layer by user wiring still decides which transaction database
+is used. Queue settings, retry settings, credentials, screenshots, and
+notifications remain `config.toml` settings; they are not part of the project
+manifest schema.
+
+Create a `config.toml` in your project:
+
+```toml
+max_retries = 2
+retry_delay = 0.0
+retry_backoff = 1.0
+log_level = "INFO"
+log_format = "text"  # "text" or "json"
+transaction_db_path = "rpacore.db"
+screenshot_dir = ""
+credential_provider = "env"
+
+[queue]
+db_path = "queue.db"
+lease_timeout = 30
+max_retries = 3
+
+# [notification.email]
+# host = "smtp.example.com"
+# port = 587
+# from_addr = "rpacore@example.com"
+# to_addrs = ["admin@example.com"]
+# attach_screenshots = true
+
+# [notification.webhook]
+# url = "https://hooks.example.com/rpacore"
+# include_transaction = false
+```
+
+## Exception Model
+
+| Exception | Meaning | Engine behavior |
+|---|---|---|
+| `BusinessException` | Expected rule violation, such as invalid input data. | Skill fails, execution continues. |
+| `SystemException` | Technical failure, such as network or file errors. | Skill fails, execution stops, retryable. |
+| Any other exception | Unhandled Python exception. | Wrapped as `SystemException`. |
+
+Use `stop=True` for a business failure that should stop downstream work:
+
+```python
+raise BusinessException("bad row", action=self.name, stop=True)
+```
+
+## Timeouts and Deadlines
+
+RPA Core does not provide a generic per-skill timeout. Python threads cannot be
+safely stopped, so an in-process timeout can mark a skill failed while the timed
+out code keeps running and mutating external systems.
+
+Configure I/O timeouts in the library that performs the work, such as the HTTP,
+SMTP, browser, database, or desktop automation client used by a skill. If an
+automation needs a hard deadline with termination, run it behind an external
+worker-process or orchestrator boundary and record the outcome back into RPA
+Core. RPA Core v0.1.0 intentionally rejects Pebble or similar process-timeout
+dependencies because process termination cannot make arbitrary external side
+effects reversible. See [Runtime Dependency Decisions](docs/runtime-dependencies.md)
+for the v0.1.0 decisions on process-timeout libraries, Pydantic, Tenacity, and
+AnyIO.
+
+## Optional Dependencies
+
+```bash
+pip install "rpacore[screenshots]"   # mss: auto-capture screenshots on exception
+pip install "rpacore[keyring]"       # keyring: OS credential store integration
+```
+
+## Examples
+
+This repo keeps a minimal in-repo automation under `examples/` to support
+integration-style tests for the framework itself:
+
+- `examples/sample_skill.py`
+- `examples/sample_main.py`
+
+For a step-by-step beginner guide, see [docs/tutorial.md](docs/tutorial.md).
+
+For persistence, migrations, and crash-behavior details, see
+[docs/durability.md](docs/durability.md). For CLI, API, config, export, and
+import-boundary references, see [docs/README.md](docs/README.md).
+For vulnerability reporting and local security posture, see
+[SECURITY.md](SECURITY.md) and [docs/security.md](docs/security.md).
+
+For fuller showcase automations, see the examples repository:
+
+- examples repository: `rpacore-examples`
+
+## Local-First Direction
+
+RPA Core Cloud is a future optional orchestrator/control plane. The framework
+itself must stay useful without it:
+
+- projects remain normal Python repos
+- runs persist locally
+- logs, reports, queues, transactions, and artifacts stay readable
+- future worker/orchestrator contracts should be documented and exportable
+
+Cloud and remote orchestration are not part of v0.1.0; see
+[docs/non-goals.md](docs/non-goals.md).
+
+## Compatibility Baseline
+
+`v0.1.0` is the first supported public compatibility baseline. Breaking changes
+made before that release are tracked for maintainers in
+[docs/pre-v0.1.0-api-migration.md](docs/pre-v0.1.0-api-migration.md), not hidden
+behind compatibility aliases.
+
+## License
+
+Apache 2.0. See [LICENSE](LICENSE).