Metadata-Version: 2.4
Name: liteyukibot-v7
Version: 7.0.0b2
Summary: A protocol-neutral, multi-runtime chatbot kernel.
Author: LiteyukiStudio
License-Expression: LicenseRef-LSO
License-File: LICENSE
Requires-Dist: cryptography>=46,<51
Requires-Dist: filelock>=3.19,<4
Requires-Dist: pydantic>=2.13,<3
Requires-Dist: pyyaml>=6,<7
Requires-Dist: prompt-toolkit>=3.0,<4
Requires-Dist: tomli-w>=1.2,<2
Requires-Dist: yukilog>=1,<2
Requires-Dist: fastapi>=0.141,<1 ; extra == 'http'
Requires-Dist: uvicorn>=0.52,<1 ; extra == 'http'
Requires-Dist: pyyaml>=6,<7 ; extra == 'yaml'
Requires-Python: >=3.14
Provides-Extra: http
Provides-Extra: yaml
Description-Content-Type: text/markdown

<div align="center">

[![][banner]][liteyuki-link]
<h2><a href="https://bot.liteyuki.org"><span style="color: #a2d8f4">LiteyukiBot</span> <span style="color: #d0e9ff">v7</span></a></h2>
<h4><span style="color: #a2d8f4">Protocol-neutral, multi-runtime chatbot kernel</span></h4>

[![][Liteyuki7]][liteyuki-link]
[![][Python3.14]][python-link]
[![][Usage]][usage-link]
[![][Repo]][repo-link]
[![][Github]][github-link]

</div>

## About

LiteyukiBot v7 is a CPython 3.14 chatbot kernel. It owns configuration,
native-plugin lifecycle, routing, permissions, logging, and local runtime IPC.
Framework integrations run as separately installed supervised child runtimes;
they exchange frozen Event and Action models with the kernel rather than SDK
objects.

The default branch is the maintained LiteyukiBot v7 line. The prior v6 line is
preserved on the `v6` branch. Its current published release is
`liteyukibot-v7==7.0.0b2`.

## Features

- interactive or non-interactive project initialization through `liteyuki`;
- immutable TOML/JSON configuration with includes, environment variables, CLI
  overrides, provenance inspection, encrypted runtime secrets, and recovery
  material for configuration upgrades;
- native plugins with explicit entry points, lifecycle hooks, services,
  managed tasks, private storage, resource packs, and localized text;
- authenticated loopback IPC, child-runtime supervision, per-conversation
  event ordering, bounded concurrency, and routed protocol-neutral actions;
- retained and verifiable runtime plugin generations with source indexes,
  rollback, disable/enable, and garbage collection commands;
- first-party command, permission, resource, profile, essential-command, and
  agent packages;
- bounded LiteyukiBot v6 compatibility and separate NoneBot2, native OneBot
  v11, AstrBot, and Neo-MoFox runtime packages.

## Install And Run

Requirements:

- CPython 3.14 or later;
- [uv][uv-link].

Install the command-line tool and create a workspace:

```bash
uv tool install --python 3.14 liteyukibot-v7
mkdir my-bot
liteyuki --workspace my-bot init
liteyuki --workspace my-bot check
liteyuki --workspace my-bot run
```

`liteyukibot`, `liteyuki`, and `ly` are equivalent command names. Use
`init --non-interactive --locale en-US` for automation. The generated
`liteyuki.toml` is the workspace configuration; see
[configuration operations](docs/configuration.md) for secrets, profiles,
configuration precedence, and recovery procedures.

To work from a checkout instead of a tool installation:

```bash
uv sync --locked --all-packages
uv run liteyuki init
uv run liteyuki check
uv run liteyuki run
```

## Packages

The kernel package is `liteyukibot-v7`. Optional features are separate PyPI
packages and must be installed into the same environment before they are
enabled in `liteyuki.toml`.

| Package | Current responsibility |
| --- | --- |
| `liteyukibot-v7-permissions` | Exact-principal capability policy service. |
| `liteyukibot-v7-commands` | Protocol-neutral command router and schemas. |
| `liteyukibot-v7-resources` | Declarative resource and authorization boundary. |
| `liteyukibot-v7-profile` | Persistent per-bot nickname and language profiles. |
| `liteyukibot-v7-essentials` | Help and protected status commands. |
| `liteyukibot-v7-functions` | v6 `.lyf`, `.lyfunction`, and `.mcfunction` executor. |
| `liteyukibot-v7-runtime-nonebot` | Supervised NoneBot2 runtime host. |
| `liteyukibot-v7-runtime-adapter` | Supervised Python platform-adapter host. |
| `liteyukibot-v7-adapter-onebot` | Native OneBot v11 HTTP Post and HTTP API adapter. |
| `liteyukibot-v7-runtime-v6` | Bounded LiteyukiBot v6 compatibility runtime. |
| `liteyukibot-v7-agent-resolver` | Declarative agent module and tool resolver. |
| `liteyukibot-v7-agent` | OpenAI-compatible native agent runtime. |
| `liteyukibot-v7-runtime-astrbot` | Headless AstrBot agent runtime. |
| `liteyukibot-v7-runtime-mofox` | Headless Neo-MoFox agent runtime. |

Read the package README in [`packages/`](packages/README.md) before enabling a
package. The kernel does not install framework integrations implicitly.

## Docker

Build the current image locally:

```bash
docker build -t liteyukibot:v7-local .
docker run --rm liteyukibot:v7-local version
```

The image runs as a non-root user. Mount `/app/data`, `/app/cache`, and
`/app/plugins` for persistent state, then provide `/app/liteyuki.toml` for a
configured deployment.

## Services And Support

Current installation, configuration, compatibility, and release boundaries are
documented in this repository. Report reproducible defects or documentation
errors through the [GitHub repository][github-link], including the installed
package versions, operating system, Python version, and the minimal command or
configuration that reproduces the result. Do not include vault passwords,
tokens, or message payloads in public reports.

## Documentation

- [Configuration operations](docs/configuration.md)
- [v7 architecture](docs/architecture/v7.md)
- [Beta1 contract and support boundary](docs/beta1.md)
- [v6 compatibility](docs/migration-v6.md)
- [Native plugin development](docs/development/native-plugins.md)
- [Custom runtime development](docs/development/custom-runtimes.md)
- [Contributor guide](CONTRIBUTING.md)
- [Release procedure](docs/development/releasing.md)

## References

- [NoneBot](https://nonebot.dev/) informs the separately packaged NoneBot
  runtime boundary.
- [AstrBot](https://github.com/AstrBotDevs/AstrBot) and
  [Neo-MoFox](https://github.com/MoFox-Studio/Neo-MoFox) inform their respective
  headless agent-runtime integrations.

## Other

This repository is a uv workspace containing the kernel, first-party packages,
examples, tests, developer tools, documentation, and release workflows.
Directory-level development guidance is provided by each directory's README.

[Liteyuki7]: https://img.shields.io/badge/LiteyukiBot-7.0.0b2-blue?style=for-the-badge
[Python3.14]: https://img.shields.io/badge/Python-3.14+-blue?style=for-the-badge
[Usage]: https://img.shields.io/badge/Usage-CLI-blue?style=for-the-badge
[Repo]: https://img.shields.io/badge/Distribution-PyPI-blue?style=for-the-badge
[Github]: https://img.shields.io/badge/GitHub-Repository-blue?style=for-the-badge
[banner]: https://socialify.git.ci/LiteyukiStudio/LiteyukiBot/image?description=1&font=Source+Code+Pro&forks=1&issues=1&name=1&owner=1&pattern=Floating+Cogs&pulls=1&stargazers=1&theme=Auto

[python-link]: https://www.python.org/
[uv-link]: https://docs.astral.sh/uv/
[usage-link]: docs/configuration.md
[liteyuki-link]: https://github.com/LiteyukiStudio/LiteyukiBot
[repo-link]: https://pypi.org/project/liteyukibot-v7/
[github-link]: https://github.com/LiteyukiStudio/LiteyukiBot
