tflows 0.0.9.dev0__tar.gz → 1.0.1__tar.gz

tflows-1.0.1/CHANGELOG.md

@@ -0,0 +1,91 @@
+# Changelog
+
+All notable changes to tflows are documented here.
+
+## [Unreleased]
+
+No changes yet.
+
+## [1.0.1] - 2026-09-06
+
+### Added
+
+- **Conditionals**: `if` / `elif` / `else` / `endif` with `==`, `!=`, `>`,
+  `<`, `>=`, `<=`, `contains`, `startswith`, `endswith`, `in`, `and` / `or` /
+  `not`, and nesting (`tflows/conditionals.py`).
+- **Slash commands**: `bot.command(..., slash=True, slash_params=[...])` and
+  `bot.slashcommand(...)`; params map to `$args` / `$arg(n)` / `$arg(name)`.
+  Sync with `await bot.sync_commands()`.
+- **Cooldowns and permission guards**: `cooldown 5s per user|channel|guild|global`
+  and `require manage_messages` / `require role Mod` / `require owner`, plus
+  `$hasrole()` / `$hasperm()` / `$isowner` variables.
+- **Persistent per-server state**: SQLite-backed `set` / `get` / `del` /
+  `incr` functions and `$get(key, fallback)` (lazy `tflows.db` by default,
+  `state_path=":memory:"` / `None` supported).
+- **Scheduled tasks**: `bot.schedule(name, code, interval=...)` with duration
+  strings and 5-field cron, `every 1h:` headers, no-duplicate replacement,
+  clean start/stop, and `run_once` for on-demand runs.
+- **Event triggers**: `bot.on_event("join"|"leave"|"react"|..., code)` with an
+  extensible `tflows.events.EVENT_MAP`; `bot.remove_event()` to detach.
+- `examples/advanced.py` showcasing all of the above; README documents every
+  feature with complete examples.
+- 84 new tests covering all six features (169 total, all passing).
+
+## [1.0.0] - 2026-08-31
+
+First stable release.
+
+### Added
+
+- Command **arguments**: `$args`, `$arg(n)` (including negative indexing and
+  `a:b` slices) and `$argcount`.
+- New variables: `$user`/`$author`, `$channel`, `$bot`, `$random`, `$prefix`,
+  `$command`, plus extended `$server`/`$guild` fields (`id`, `icon`, `owner`,
+  `members`, `created`, `description`).
+- New functions: `reply`, `wait` (with `s`/`m`/`h`/`d` suffixes), `react`,
+  `delete`, `clear`.
+- Built-in `help` command with per-command details.
+- Command `description` and `aliases` support.
+- Comment lines in scripts (`//`, `#`, `--`).
+- Embed enhancements: `$thumbnail`, `$image`, `$author`, `$timestamp`, named
+  colors, and fields in the single-line `embed` form.
+- `FlowBot` options: `help_command`, `log_errors`, `case_insensitive`,
+  `members_intent`, and isolated `registry`.
+- Script errors are logged instead of crashing the bot; unknown functions are
+  logged (both configurable).
+- `FlowContext` object that carries the invoking command name and arguments
+  while remaining drop-in compatible with raw discord messages.
+- Mixing with regular discord.py commands, cogs, and listeners via
+  `process_commands` fallback.
+- Full pytest test suite (85 tests) with a fake Discord context.
+- `tflows.__version__`, `CHANGELOG.md`, and expanded examples.
+
+### Fixed
+
+- **Packaging**: the `tflows.function` subpackage was missing from built
+  distributions, breaking the loader at runtime. Packages are now discovered
+  with `setuptools.find`.
+- `embed` function awaited missing coroutines; embed fields previously showed
+  `<coroutine object ...>`.
+- Removed duplicate function/variable registrations between `registry.py` and
+  the `function/` modules.
+- Removed deprecated `datetime.utcnow()` usage.
+- Resolved the MIT vs Apache-2.0 license inconsistency — the project is now
+  consistently Apache-2.0 across metadata, `License`, and `NOTICE`.
+- Added proper `.gitignore` for build artifacts.
+
+### Changed
+
+- `engine.run()` now accepts either a raw `discord.Message` (backward
+  compatible) or a `FlowContext`.
+- Internal logger migrated from `print` to the `logging` module
+  (`tflows.engine`, `tflows.bot`, ...).
+- README rewritten to document the full variable/function catalog.
+
+### Removed
+
+- None (all existing public APIs remain backward compatible).
+
+## [0.0.8] - 2026-05-30
+
+- Initial script engine with `send`, `log`, and a small set of variables.

tflows-0.0.9.dev0/License → tflows-1.0.1/LICENSE

@@ -1,16 +1,16 @@
-# Apache License 2.0
-
-Copyright (c) 2026 Tonie
-
-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
-
-https://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
+# Apache License 2.0
+
+Copyright (c) 2026 Tonie
+
+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
+
+https://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.

tflows-1.0.1/MANIFEST.in

@@ -0,0 +1,4 @@
+include LICENSE
+include NOTICE
+include CHANGELOG.md
+recursive-include examples *.py

{tflows-0.0.9.dev0 → tflows-1.0.1}/NOTICE

@@ -1,118 +1,118 @@
-# 📢 NOTICE
-
-This project, **tflows.py**, is a lightweight automation and Discord bot framework designed to simplify bot creation through a script-based execution engine.
-
-It is developed and maintained by **Tonie**.
-
----
-
-## 📌 Attribution Requirement
-
-If you use this software in any form, whether modified or unmodified, you must include clear attribution to the original author:
-
-**Required credit format:**
-- tflows.py by Tonie  
-- or “Powered by tflows.py (Tonie)”
-
-Attribution must be visible in one of the following:
-- Project documentation
-- Source code comments (if redistributed as code)
-- Application output, UI, or credits section (if used in a product)
-- About page or equivalent location in software interfaces
-
----
-
-## ⚙️ Project Description
-
-tflows.py is built around a custom scripting engine that allows users to define Discord bot behavior using simple text commands.
-
-Instead of writing complex event handlers for every action, tflows translates structured command scripts into executable functions.
-
-Key design goals:
-- Reduce boilerplate in Discord bot development
-- Provide an extensible function registry system
-- Enable fast prototyping of automation workflows
-- Keep logic readable and script-based
-
----
-
-## 🧩 Core System Overview
-
-The framework operates through a modular execution pipeline:
-
-1. Command Input Parsing  
-   Scripts are read line-by-line and split into executable instructions.
-
-2. Function Mapping  
-   Each instruction is matched to a registered internal function.
-
-3. Context Execution  
-   Commands run inside Discord event contexts asynchronously.
-
-4. Output Handling  
-   Responses are sent to Discord or logged depending on function behavior.
-
----
-
-## 🔌 Extensibility
-
-tflows.py supports user-defined functions through a registry system.
-
-Developers can:
-- Add custom commands
-- Override default behaviors
-- Extend scripting capabilities
-- Integrate external APIs or services
-
-This makes tflows suitable for both simple bots and advanced automation systems.
-
----
-
-## 📦 Usage Context
-
-tflows.py may be used for:
-- Discord bots
-- Automation tools
-- Lightweight scripting systems
-- Educational projects
-- Rapid prototyping of command-based systems
-
----
-
-## ⚠️ Restrictions
-
-While Apache 2.0 allows broad usage, attribution under this NOTICE file is required when:
-- Redistributing the software
-- Using it in closed-source applications
-- Building derivative systems
-- Embedding it into larger frameworks or platforms
-
-Failure to provide attribution violates the intended use of this project identity.
-
----
-
-## 🧠 Project Identity
-
-tflows.py is not just a library, but a scripting execution concept focused on simplifying Discord bot logic into readable command flows.
-
-It emphasizes:
-- Minimal setup
-- Script-first design
-- Expandable function system
-- Developer accessibility
-
----
-
-## 📜 License Notice
-
-This NOTICE file is intended to supplement the Apache License 2.0 under which this project is distributed.
-
-The Apache 2.0 license remains the primary legal license governing usage, distribution, and modification.
-
----
-
-## 👤 Author
-
-Developed and maintained by **Tonie**
-
+# 📢 NOTICE
+
+This project, **tflows.py**, is a lightweight automation and Discord bot framework designed to simplify bot creation through a script-based execution engine.
+
+It is developed and maintained by **Tonie**.
+
+---
+
+## 📌 Attribution Requirement
+
+If you use this software in any form, whether modified or unmodified, you must include clear attribution to the original author:
+
+**Required credit format:**
+- tflows.py by Tonie  
+- or “Powered by tflows.py (Tonie)”
+
+Attribution must be visible in one of the following:
+- Project documentation
+- Source code comments (if redistributed as code)
+- Application output, UI, or credits section (if used in a product)
+- About page or equivalent location in software interfaces
+
+---
+
+## ⚙️ Project Description
+
+tflows.py is built around a custom scripting engine that allows users to define Discord bot behavior using simple text commands.
+
+Instead of writing complex event handlers for every action, tflows translates structured command scripts into executable functions.
+
+Key design goals:
+- Reduce boilerplate in Discord bot development
+- Provide an extensible function registry system
+- Enable fast prototyping of automation workflows
+- Keep logic readable and script-based
+
+---
+
+## 🧩 Core System Overview
+
+The framework operates through a modular execution pipeline:
+
+1. Command Input Parsing  
+   Scripts are read line-by-line and split into executable instructions.
+
+2. Function Mapping  
+   Each instruction is matched to a registered internal function.
+
+3. Context Execution  
+   Commands run inside Discord event contexts asynchronously.
+
+4. Output Handling  
+   Responses are sent to Discord or logged depending on function behavior.
+
+---
+
+## 🔌 Extensibility
+
+tflows.py supports user-defined functions through a registry system.
+
+Developers can:
+- Add custom commands
+- Override default behaviors
+- Extend scripting capabilities
+- Integrate external APIs or services
+
+This makes tflows suitable for both simple bots and advanced automation systems.
+
+---
+
+## 📦 Usage Context
+
+tflows.py may be used for:
+- Discord bots
+- Automation tools
+- Lightweight scripting systems
+- Educational projects
+- Rapid prototyping of command-based systems
+
+---
+
+## ⚠️ Restrictions
+
+While Apache 2.0 allows broad usage, attribution under this NOTICE file is required when:
+- Redistributing the software
+- Using it in closed-source applications
+- Building derivative systems
+- Embedding it into larger frameworks or platforms
+
+Failure to provide attribution violates the intended use of this project identity.
+
+---
+
+## 🧠 Project Identity
+
+tflows.py is not just a library, but a scripting execution concept focused on simplifying Discord bot logic into readable command flows.
+
+It emphasizes:
+- Minimal setup
+- Script-first design
+- Expandable function system
+- Developer accessibility
+
+---
+
+## 📜 License Notice
+
+This NOTICE file is intended to supplement the Apache License 2.0 under which this project is distributed.
+
+The Apache 2.0 license remains the primary legal license governing usage, distribution, and modification.
+
+---
+
+## 👤 Author
+
+Developed and maintained by **Tonie**
+
 All contributions, forks, and derivatives should retain visible credit to the original project source.