Metadata-Version: 2.4
Name: tflows
Version: 1.0.1
Summary: A lightweight automation and Discord bot framework that lets you build bots using a simple scripting system.
Author: Tonie
License: # 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.
Project-URL: Homepage, https://github.com/TonieC/tflows.py
Project-URL: Repository, https://github.com/TonieC/tflows.py
Project-URL: Issues, https://github.com/TonieC/tflows.py/issues
Project-URL: Documentation, https://github.com/TonieC/tflows.py
Project-URL: Discord, https://discord.gg/CMSXnfcCJW
Keywords: discord,bot,automation,scripting,framework,discord-bot
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
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: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Communications :: Chat
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: NOTICE
Requires-Dist: discord.py>=2.3.0
Provides-Extra: dev
Requires-Dist: pytest>=7; extra == "dev"
Requires-Dist: pytest-asyncio; extra == "dev"
Requires-Dist: black; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Requires-Dist: build; extra == "dev"
Requires-Dist: twine; extra == "dev"
Dynamic: license-file

# tflows.py

tflows.py is a lightweight automation and Discord bot framework built around a
scripting engine. Instead of writing Python event handlers for every action,
you define bot behavior as simple text scripts:

```py
from tflows import FlowBot

bot = FlowBot(prefix="!")

bot.command(
    name="ping",
    code="""
    // Send a reply with the current latency
    reply Pong! $ping
    """,
)

bot.run("YOUR_BOT_TOKEN")
```

It is designed for fast bot development, easy customization, and extensible
command logic — while staying fully compatible with discord.py so you can mix
scripts and regular commands.

---

## Features

- Script-based command system — write bot logic as plain text
- Built-in `$variable` templates (`$user`, `$server`, `$args`, `$ping`, ...)
- Command arguments: `$args`, `$arg(0)`, `$argcount`
- Conditionals: `if` / `elif` / `else` / `endif` with comparisons and nesting
- Slash commands via `slash=True` or `bot.slashcommand(...)`
- Cooldowns (`cooldown 5s per user`) and permission guards (`require ...`)
- SQLite persistent per-server state: `set` / `get` / `del` / `incr`
- Scheduled tasks (`bot.schedule(...)`, `every 1h`, cron) and event triggers (`bot.on_event("join", ...)`)
- Rich embeds, both as blocks and single-line commands
- Built-in `help` command, aliases, and command descriptions
- Comment support in scripts (`//`, `#`, `--`)
- Async Discord integration using discord.py 2.x
- Extensible registry: add your own functions and variables
- Mixing with regular discord.py commands, cogs, and listeners

---

## Installation

```bash
pip install tflows
```

Requires Python 3.10+.

---

## Quick Start

```py
from tflows import FlowBot

bot = FlowBot(prefix="!")

bot.command(
    name="hello",
    code="""
    reply Hello $user(display)!
    """,
)

bot.run("YOUR_BOT_TOKEN")
```

### Command registration

`FlowBot.command(name, code, description="", aliases=())` registers a script
command:

```py
bot.command(
    name="greet",
    code="reply Hello $args",
    description="Greets the given name.",
    aliases=("hi", "hey"),
)
```

Both `!greet`, `!hi` and `!hey` now trigger the same script.

### The built-in help command

By default `!help` lists every script command, and `!help <command>` shows its
description, aliases, usage, and source script. Disable it with
`FlowBot(prefix="!", help_command=False)`.

---

## Variables

Variables are replaced anywhere in a script, including inside function
arguments. Usage is `$name` or `$name(option)`.

| Variable | Options | Description |
| --- | --- | --- |
| `$user` / `$author` | `name`, `display`, `id`, `mention`, `avatar`, `bot`, `created`, `joined`, `tag` | Information about the message author |
| `$server` / `$guild` | `name`, `id`, `icon`, `owner`, `members`, `boost`, `boostlvl`, `created`, `description` | Information about the current guild |
| `$channel` | `name`, `id`, `mention`, `topic`, `nsfw`, `type`, `position`, `category`, `created` | Information about the current channel |
| `$bot` | `name`, `id`, `mention`, `avatar`, `status`, `ping`, `uptime` | Information about the bot itself |
| `$args` | — | Everything typed after the command name |
| `$arg(n)` | `0`-based index, negative counts from the end, `a:b` slices, or a slash-parameter name | A single argument |
| `$argcount` | — | Number of arguments |
| `$get(key)` / `$state(key)` | `$get(points)`, `$get(points, 0)` | Inline read of persistent state (with optional fallback) |
| `$hasrole(name)` | `$hasrole(Moderator)` | `true` when the author has the role |
| `$hasperm(name)` | `$hasperm(manage_messages)` | `true` when the author has the permission |
| `$isowner` | — | `true` when the author owns the server |
| `$ping` | — | The bot's current latency |
| `$time` | `12h`, `24h`, `nodate`, `notime` | Current time |
| `$uptime` | `full`, `short`, `clock`, `seconds`, custom like `d:h:m:s` | Bot uptime |
| `$membercount` | `all`, `user`, `bots` | Member counts |
| `$random` | `a, b` (inclusive range) | A random number |
| `$id` | — | The author's user ID |
| `$avatar` / `$image` | — | The author's avatar URL |
| `$prefix` | — | The bot's command prefix |
| `$command` | — | The currently running command name |

Unknown variables are left untouched so typos never silently corrupt output.

Example:

```
!greet world
```
```
reply Hello $args            # -> Hello world
reply First: $arg(0)         # -> First: world
reply Count: $argcount       # -> Count: 1
```

---

## Functions

Every line of a script calls one function:

```
<function-name> <arguments...>
```

### Core functions

| Function | Example | Description |
| --- | --- | --- |
| `send` | `send hello` | Sends a message to the current channel |
| `reply` | `reply hi $user` | Replies to the invoking message |
| `log` | `log command ran` | Prints a message to the console |
| `wait` | `wait 3s` | Waits (`s`, `m`, `h`, `d` suffixes supported) |
| `react` | `react ✅` | Adds reactions to the invoking message |
| `delete` | `delete` | Deletes the invoking message |
| `clear` | `clear 10` | Purges recent messages (needs Manage Messages) |
| `ping` | `ping` | Replies with the bot's latency |
| `set` | `set points 10` / `set points +5` | Stores persistent state (`+N`/`-N` increments atomically) |
| `get` | `get points` / `get points 0` | Sends the stored value (with optional fallback) |
| `del` | `del points` | Forgets a stored key |
| `incr` | `incr points 3` | Atomically increments a counter (default `1`) |

### Embeds

The block form is best for rich, multi-line embeds:

```
embed
$title[Server Stats]
$desc[
Members: $membercount
Uptime: $uptime(full)
]
$footer[Requested by $user(display)]
$color[blurple]
$thumbnail[$bot(avatar)]
endembed
```

Supported keys: `$title`, `$desc`, `$footer`, `$color` (hex or named), `$thumbnail`,
`$image`, `$author`, `$timestamp`. Named colors include `white`, `black`, `red`,
`green`, `blue`, `yellow`, `orange`, `purple`, `pink`, `grey`, `blurple`, `gold`,
`teal`, `cyan`, and `brown`.

A single-line form using the `embed` function is also available, with keys
separated by `|` and fields via `field: Name;Value;inline`:

```
embed $embed<title: $user(display) | desc: Level 42 | color: green | field: Role;Admin;true>
```

### Comments

Lines starting with `//`, `#`, or `--` are ignored.

---

## Conditionals

Branch directly in scripts — no Python needed:

```
if $argcount > 1:
    reply Multiple arguments: $args
elif $argcount == 1:
    reply One argument: $arg(0)
else:
    reply Give me something to echo!
endif
```

- `endif` is optional when the block runs to the end of the script, or when
  dedentation shows where it ends (a dedented line after an indented block
  closes it). Use `endif` when unconditional code follows, or when lines are
  not indented.
- Operators: `==`, `!=`, `>`, `<`, `>=`, `<=`, `contains`, `startswith`,
  `endswith`, `in`. Numbers compare numerically, everything else
  case-insensitively as text.
- Combine clauses with `and` / `or`, negate with `not`. A bare value is
  truthy unless empty or `0` / `false` / `no` / `none`.
- Blocks nest. Conditions see all `$variables`, so guards like
  `if $hasrole(Moderator):`, `if $hasperm(manage_messages):`,
  `if $channel == announcements:` and `if $user == SomeName:` all work.

---

## Cooldowns and permission guards

Declare controls at the top of a command script:

```
cooldown 5s per user
require manage_messages
require role Moderator
require owner
```

- `cooldown <duration> [per user|channel|guild|global]` (default `per user`).
  Durations accept `s`, `m`, `h`, `d` suffixes. While on cooldown the script
  is skipped and the user is told how long to wait.
- `require <permission>` checks Discord permissions
  (`manage_messages`, `administrator`, `kick_members`, ...),
  `require role <name>` checks a role (with `admin`/`mod` shortcuts),
  `require owner` checks server ownership. Unauthorized users get a denial
  message and the script never runs. Unparseable `require` lines fail closed.

---

## Persistent state

SQLite-backed storage that survives restarts and is isolated per server:

```
set points[$user] +10
get points[$user]
```

`set <key> <value>` stores text; a `+N`/`-N` value increments atomically
(counters, safe under concurrency). `get <key> [fallback]` sends the value,
`del <key>` forgets it, `incr <key> [amount]` bumps a counter silently, and
`$get(key, fallback)` reads state inline. Because variables resolve first,
dynamic keys like `points[$user]` just work.

```py
bot = FlowBot(prefix="!")                      # state in ./tflows.db
bot = FlowBot(prefix="!", state_path=":memory:")  # tests / no persistence
bot = FlowBot(prefix="!", state_path=None)        # disable state
```

---

## Scheduled tasks

Run scripts on a timer without blocking the bot:

```py
bot.schedule("hourly", "send Hourly check-in", interval="1h")
bot.schedule("standup", code="send Standup time!", interval="5m", channel=123456789)
bot.schedule("midnight", code="send New day!", cron="0 0 * * *")
```

- Intervals accept seconds or `"30s"` / `"5m"` / `"1h"` / `"1d"` strings;
  `cron` accepts 5-field expressions (`minute hour day month weekday`).
- A leading `every 1h:` / `cron ...:` header inside `code` also works and is
  ignored when the same script runs as a command.
- Re-scheduling a name replaces the old task (no duplicates). Tasks start
  with the bot, stop cleanly via `await bot.scheduler.stop_all()` /
  `await bot.close()`, and `await bot.scheduler.run_once("hourly")`
  triggers a run on demand. `bot.unschedule("hourly")` removes one.

---

## Event triggers

React to Discord events with plain scripts — no command invocation needed:

```py
bot.on_event("join", "send Welcome $user(mention)!")   # member joins
bot.on_event("leave", "send Bye $user(name)!")         # member leaves
bot.on_event("react", "send $user(display) reacted!")  # reaction added
```

A leading `on <event>:` header inside the code is accepted verbatim.
Supported names include `join`, `leave`/`remove`, `react`/`reaction`,
`unreact`, `message`, `typing` (see `tflows.events.EVENT_MAP`); new events
are added by extending that map without changing the language. Handlers are
removed with `bot.remove_event("join", name)`.

---

## Slash commands

Add a slash variant to any script command — the prefix command keeps working:

```py
bot.command(
    name="greet",
    code="reply Hello $arg(0)!",
    description="Greet someone",
    slash=True,
    slash_params=["name"],
)

bot.slashcommand(
    name="roll",
    code="send Rolled $arg(0)!",
    description="Roll dice",
    params=["sides: int"],
)

# after the bot is ready:
await bot.sync_commands()
```

Parameters map positionally into `$args` / `$arg(0)` / `$argcount` and by
name into `$arg(name)`. Params accept `"name"`, `"name: int|float|bool|str"`,
`("name", type)` tuples, or dicts. Slash, prefix, event, and scheduled
scripts can all coexist in one bot.

---

## Mixing with discord.py

Because `FlowBot` subclasses `discord.ext.commands.Bot`, everything discord.py
offers keeps working: cogs, listeners, `@bot.event`, app commands, etc. When a
message matches the prefix but not a script command, it is passed through to
discord.py's command processor automatically.

```py
import discord
from discord.ext import commands
from tflows import FlowBot

class Moderation(commands.Cog):
    @commands.command()
    async def purge(self, ctx, limit: int):
        await ctx.channel.purge(limit=limit)

bot = FlowBot(prefix="!")
bot.command(name="hello", code="reply Hi $user(display)!")
bot.add_cog(Moderation(bot))
bot.run("YOUR_BOT_TOKEN")
```

---

## Custom functions and variables

Functions are callables `fn(ctx, args)` and variables are callables
`var(ctx, args)` that return a string (or an awaitable). Register them on the
shared registry:

```py
from tflows import FlowBot
from tflows.registry import registry

@registry.register("shrug")
async def shrug(ctx, args):
    await ctx.channel.send("¯\\_(ツ)_/¯")

@registry.register_var("uptime_hours")
def uptime_hours(ctx, args):
    return str(bot_uptime_seconds() // 3600)

bot = FlowBot(prefix="!")
```

Alternatively, create an isolated bot with its own registry:
`FlowBot(prefix="!", registry=FunctionRegistry())`.

### FlowBot options

| Option | Default | Description |
| --- | --- | --- |
| `prefix` | `"!"` | Command prefix (a string or list of strings) |
| `help_command` | `True` | Enable the built-in `!help` command |
| `log_errors` | `True` | Log script errors instead of raising |
| `log_unknown_functions` | `True` | Log unknown function names |
| `case_insensitive` | `False` | Match command names case-insensitively |
| `members_intent` | `False` | Enable the privileged members intent |
| `registry` | shared | Use an isolated `FunctionRegistry` |
| `state_path` | `"tflows.db"` | SQLite state file (lazy); `":memory:"` for tests, `None` to disable |

---

## Examples

See the `examples/` directory:

- `basic_bot.py` — minimal bot
- `variables.py` — variable showcase
- `embeds.py` — block and single-line embeds
- `automation.py` — `wait`, `react`, `delete`, `clear`
- `mixing.py` — scripts alongside discord.py cogs
- `advanced.py` — conditionals, guards, state, schedules, events, slash

Run any example after installing the package:

```bash
python examples/basic_bot.py
```

---

## License

Apache License 2.0 — see the `License` file. Attribution to the original author
is required when redistributing or embedding the software; see `NOTICE`.
