Metadata-Version: 2.4
Name: solux
Version: 0.5.0
Summary: Local-first AI workflow engine for chaining inputs, transforms, and local LLM steps.
Project-URL: Repository, https://github.com/sfoerster/solux
Project-URL: Changelog, https://github.com/sfoerster/solux/blob/main/CHANGELOG.md
Project-URL: Issues, https://github.com/sfoerster/solux/issues
Author-email: Steven Foerster <sfoerster@gmail.com>
License:                                  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 the 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 the 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 any 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
        
           Copyright 2026 Steven Foerster
        
           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.
License-File: LICENSE
Keywords: AI,LLM,MCP,Ollama,automation,local-first,workflow
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
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 :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Classifier: Typing :: Typed
Requires-Python: >=3.11
Requires-Dist: defusedxml<1,>=0.7
Requires-Dist: pyyaml<7,>=6.0
Requires-Dist: requests<3,>=2.31.0
Provides-Extra: dev
Requires-Dist: mypy<2,>=1.10; extra == 'dev'
Requires-Dist: pytest-cov<7,>=5.0; extra == 'dev'
Requires-Dist: pytest<9,>=8.0.0; extra == 'dev'
Requires-Dist: ruff<1,>=0.4; extra == 'dev'
Requires-Dist: types-requests<3,>=2.31; extra == 'dev'
Provides-Extra: encrypt
Requires-Dist: pysqlcipher3<2,>=1.2; extra == 'encrypt'
Provides-Extra: mcp
Requires-Dist: mcp<2,>=1.0; extra == 'mcp'
Provides-Extra: ocr
Requires-Dist: pillow<12,>=10.0; extra == 'ocr'
Requires-Dist: pytesseract<1,>=0.3.10; extra == 'ocr'
Provides-Extra: oidc
Requires-Dist: cryptography<46,>=41.0; extra == 'oidc'
Requires-Dist: pyjwt<3,>=2.8; extra == 'oidc'
Provides-Extra: pdf
Requires-Dist: pypdf<6,>=4.0; extra == 'pdf'
Provides-Extra: s3
Requires-Dist: boto3<2,>=1.34; extra == 's3'
Provides-Extra: vector
Requires-Dist: chromadb<1,>=0.4; extra == 'vector'
Description-Content-Type: text/markdown

# Solux

**Local-first AI workflow engine** — chain inputs, transforms, and AI steps into automated workflows. Everything runs on your machine.

```bash
pip install solux
solux init
solux https://example.com/any-article
```

That's it. In 60 seconds you go from zero to a working AI pipeline that fetches a webpage, cleans the text, and summarizes it with your local LLM via Ollama.

---

## What is Solux?

Solux is a local-first AI workflow engine that chains **inputs → transforms → local LLM steps → outputs** using simple YAML definitions. Think of it as a workflow automation tool designed for local AI inference — no cloud APIs, no vendor lock-in, no data leaving your machine.

You define workflows as YAML files. Each workflow is a pipeline of steps: fetch a webpage, clean the text, summarize with Ollama, write the result to a file or send it to Slack. Solux comes with 30+ built-in modules and you can add your own by dropping a `.py` file into a directory.

Solux is **CLI-first** — every feature is available from the terminal. A web UI is included for convenience but is entirely optional. Workflows can be triggered manually, on a schedule (cron), by watching a folder, polling an RSS feed or email inbox, or via inbound webhooks.

---

## Architecture

```
┌─────────────────────────────────────────────────────────────────────┐
│                        solux workflow run                            │
│                                                                      │
│  Source (URL / file / folder)                                        │
│         │                                                            │
│         ▼                                                            │
│  ┌─────────────┐    enqueue    ┌──────────────────────────────────┐ │
│  │  CLI / API  │──────────────▶│  SQLite Queue  (WAL mode)        │ │
│  │  Triggers   │               │  pending → processing → done     │ │
│  └─────────────┘               └──────────────┬───────────────────┘ │
│                                               │ claim (atomic)       │
│                                               ▼                      │
│                                    ┌──────────────────┐             │
│                                    │  Worker Thread   │             │
│                                    │  (poll / retry / │             │
│                                    │   dead-letter)   │             │
│                                    └────────┬─────────┘             │
│                                             │                        │
│                                             ▼                        │
│                                  ┌──────────────────┐               │
│                                  │ Workflow Loader   │               │
│                                  │ YAML + secrets   │               │
│                                  │ interpolation    │               │
│                                  └────────┬─────────┘               │
│                                           │                         │
│                                           ▼                         │
│                              ┌────────────────────────┐             │
│                              │   Workflow Engine       │             │
│                              │  for each Step:         │             │
│                              │  validate → when? →     │             │
│                              │  foreach? → timeout →   │             │
│                              │  run → on_error? →      │             │
│                              │  record timing          │             │
│                              └───────────┬────────────┘             │
│                                          │                          │
│              ┌───────────────────────────┼──────────────────┐       │
│              ▼               ▼           ▼          ▼        ▼      │
│         ┌────────┐    ┌───────────┐  ┌──────┐  ┌────────┐  ┌──────┐ │
│         │ input  │    │ transform │  │  ai  │  │ output │  │ meta │ │
│         │ fetch  │    │ split /   │  │ llm  │  │ file / │  │ sub- │ │
│         │ rss /  │    │ clean /   │  │ whis-│  │ web-   │  │ work-│ │
│         │ email  │    │ ocr       │  │ per  │  │ hook / │  │ flow/│ │
│         └────────┘    └───────────┘  └──────┘  │ email  │  │branch│ │
│                                                 └────────┘  └──────┘ │
│                                                 └────────┘           │
└─────────────────────────────────────────────────────────────────────┘
```

---

## Feature Highlights

### Built-in Modules (30+)

| Category | Modules |
|----------|---------|
| **Input** | `source_fetch`, `webpage_fetch`, `rss_feed`, `folder_watch`, `parse_pdf`, `email_inbox`, `youtube_playlist`, `s3_watcher` |
| **Transform** | `audio_normalize`, `text_split`, `text_clean`, `metadata_extract`, `ocr` |
| **AI** | `whisper_transcribe`, `llm_summarize`, `llm_prompt`, `llm_classify`, `llm_extract`, `llm_sentiment`, `embeddings` |
| **Output** | `file_write`, `webhook`, `local_db`, `vector_store`, `email_send`, `obsidian_vault`, `slack_notify`, `solux_node` |
| **Meta** | `workflow` (sub-workflows), `branch` (conditional routing) |

### Workflow Features

| Feature | Description |
|---------|-------------|
| Conditional steps | `when:` expressions with safe AST evaluation |
| Iteration | `foreach:` with optional `parallel` concurrency |
| Sub-workflows | Compose workflows by calling one inside another |
| Branching | Route to different workflows based on context values |
| Error handling | `on_error:` fallback workflows per step |
| Step timeouts | Per-step timeout guards with dead-letter on expiry |
| Secrets | `${env:VAR_NAME}` interpolation in any config field |

### Trigger Types (5)

| Trigger | Description |
|---------|-------------|
| Folder watch | Enqueue new files matching a glob pattern |
| RSS poll | Enqueue new feed items on an interval |
| Cron | Standard 5-field cron expressions or simple intervals |
| Email poll | IMAP inbox polling with at-least-once delivery |
| Inbound webhooks | `POST /api/trigger/{workflow}` with HMAC verification and rate limiting |

---

## Example Workflow

```yaml
name: webpage_sentiment
description: "Fetch a page, clean it, and analyze sentiment."
steps:
  - name: fetch
    type: input.webpage_fetch         # fetch and extract text from URL
    config: {}

  - name: clean
    type: transform.text_clean        # strip HTML, normalize whitespace
    config:
      input_key: webpage_text
      output_key: cleaned_text
      strip_html: true
      max_chars: 4000

  - name: sentiment
    type: ai.llm_sentiment            # classify sentiment via Ollama
    config:
      input_key: cleaned_text
      scale: pos_neg_neu

  - name: notify
    type: output.slack_notify          # send result to Slack
    when: "sentiment != 'neutral'"     # conditional: skip if neutral
    config:
      webhook_url: "${env:SLACK_WEBHOOK}"
      message_template: "Sentiment: {sentiment[label]} ({sentiment[score]:.2f})"
```

Save this as `~/.config/solux/workflows.d/webpage_sentiment.yaml` and run:

```bash
solux --workflow webpage_sentiment https://example.com/article
```

---

## CLI Reference

Solux is terminal-first — every web UI action has a CLI equivalent.

```bash
# Run workflows
solux <URL>                              # run default workflow on a URL
solux run --workflow audio_summary ep.mp3 # explicit workflow + source
solux run --dry-run <URL>                # show execution plan without running

# Workflow management
solux workflows list                     # list all workflows
solux workflows show <name>              # print workflow YAML
solux workflows validate <name>          # validate pipeline wiring
solux workflows examples                 # print example YAML templates

# Triggers
solux triggers list | show | validate | examples

# Modules
solux modules list                       # list all discovered modules
solux modules inspect <name>             # show module metadata

# Queue and workers
solux ingest url1 url2 --workflow <name> # queue sources for async processing
solux worker start [--workers 4]         # start background worker(s)
solux worker status                      # show queue counts
solux log                                # monitor queue and worker logs

# Setup and maintenance
solux init                               # guided first-run setup
solux doctor [--fix]                     # check dependencies
solux config [edit]                      # show or edit config.toml
solux serve                              # start web UI (localhost:8765)
solux cleanup --dry-run                  # preview cached artifact removal
solux retry                              # reset failed jobs to pending
solux repair                             # recover stuck jobs from filesystem

# MCP server (AI agent integration)
solux mcp                                # start MCP server over stdio
```

---

## Web UI

Start with `solux serve` (default: `http://localhost:8765`). The web UI provides:

- **Dashboard** — job queue status, source browser, output viewer
- **YAML editors** — create and edit workflows and triggers with inline validation
- **Module catalog** — browse all discovered modules with metadata
- **Job history** — paginated history with bulk retry and dead-letter management
- **Live updates** — SSE-based queue count badges
- **OIDC authentication** — integrate with Keycloak, Auth0, Dex, etc.
- **RBAC** — admin / operator / viewer roles

Every web UI action has a terminal equivalent. The UI is a convenience layer, not a requirement.

---

## Security

### Security Modes

Solux supports `trusted` and `untrusted` modes via `config.toml`:

```toml
[security]
mode = "trusted"   # or "untrusted"
```

- **Trusted**: all modules can run.
- **Untrusted**: modules marked `trusted_only` or `network=true` are blocked. External modules are disabled.

### Additional Security Features

- **OIDC + RBAC** — protect the web UI with external identity providers and role-based access
- **Audit logging** — optional SQLCipher encryption at rest with HMAC chain signing
- **Webhook HMAC** — `X-Solux-Signature` header verification on inbound webhooks
- **Rate limiting** — per-IP sliding window on webhook endpoints (default: 60/min)
- **XML safety** — `defusedxml` for all RSS/Atom parsing (prevents XXE, billion laughs)
- **Secrets interpolation** — `${env:VAR_NAME}` keeps credentials out of YAML files; `strict_env_vars = true` for production

---

## Deployment

### pip (recommended for development)

```bash
pip install solux           # core
pip install 'solux[pdf]'    # + PDF extraction
pip install 'solux[ocr]'    # + Tesseract OCR
pip install 'solux[s3]'     # + S3/MinIO input
pip install 'solux[vector]' # + ChromaDB vector store
pip install 'solux[oidc]'   # + OIDC JWT auth
pip install 'solux[mcp]'    # + MCP server mode
```

### Docker

```bash
docker compose up -d   # starts Ollama + Solux server + worker
```

Services bind to `127.0.0.1` by default. Enable `oidc_require_auth` before exposing ports.

### systemd

Hardened unit files in `contrib/systemd/` with `NoNewPrivileges`, `ProtectSystem=strict`, and `PrivateTmp`.

```bash
sudo cp contrib/systemd/solux-{server,worker}.service /etc/systemd/system/
sudo systemctl enable --now solux-server solux-worker
```

---

## License

Solux is licensed under the **Apache License 2.0**.

See [LICENSE](LICENSE) for full terms.

---

## Contributing

Contributions are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.

- [GitHub Issues](https://github.com/sfoerster/solux/issues) — bug reports and feature requests
- [GitHub Discussions](https://github.com/sfoerster/solux/discussions) — ideas and use-case proposals
- [Landing page](https://stevenfoerster.com/solux/) — project overview and build logs

### Development

```bash
pip install -e '.[dev]'              # pytest, ruff, mypy
pytest                                # run tests with coverage
ruff check src/ tests/               # lint
mypy src/solux/                      # type check
```
