Metadata-Version: 2.5
Name: aiogram-nav
Version: 0.1.0
Summary: Standalone navigation and recoverable screen rendering for aiogram 3
Project-URL: Homepage, https://github.com/ArmanAvanesyan/aiogram-nav
Project-URL: Documentation, https://github.com/ArmanAvanesyan/aiogram-nav/tree/main/docs
Project-URL: Repository, https://github.com/ArmanAvanesyan/aiogram-nav
Project-URL: Issues, https://github.com/ArmanAvanesyan/aiogram-nav/issues
Project-URL: Changelog, https://github.com/ArmanAvanesyan/aiogram-nav/blob/main/CHANGELOG.md
Author: aiogram-nav contributors
License-Expression: MIT
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: AsyncIO
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: Programming Language :: Python :: 3.14
Classifier: Typing :: Typed
Requires-Python: >=3.10
Requires-Dist: aiogram<4,>=3.22
Provides-Extra: redis
Requires-Dist: redis<8,>=5.0.8; extra == 'redis'
Description-Content-Type: text/markdown

# aiogram-nav

Standalone screen navigation for aiogram 3, with a typed registry, memory or Redis
repositories, prepared rendering and explicit input bindings. Use reply keyboards,
inline controls, commands or hybrids without adopting an idle framework.

Version 0.1.0 is an initial alpha release. Review the recovery and storage
boundaries before adopting it in an application.

## Install

Requires Python 3.10+ and aiogram 3.22 or newer within the 3.x series.

```sh
pip install aiogram-nav==0.1.0
# Optional persistent storage:
pip install 'aiogram-nav[redis]==0.1.0'
```

The runtime depends only on aiogram. Neither aiogram-idle nor Redis is required.
See [Redis setup and recovery](docs/redis.md). Contributors can install an editable
checkout with `uv sync --extra redis`; see [CONTRIBUTING.md](CONTRIBUTING.md).

## Run a demonstration

Clone the repository for its runnable examples, then set `BOT_TOKEN` in the environment:

```sh
git clone https://github.com/ArmanAvanesyan/aiogram-nav.git
cd aiogram-nav
uv sync --python 3.12
uv run python examples/demo.py --style reply
uv run python examples/demo.py --style inline
uv run python examples/demo.py --style commands
uv run python examples/demo.py --style hybrid --fsm
```

`/start` opens a neutral example menu. Back preserves application drafts; Cancel
uses an explicit application hook to discard only owned draft fields. The examples
configure debug logging and never configure logging globally inside the library.
CLI help runs without a token. Tests use a recording Telegram transport.

## Core behavior

- Register stable node IDs, structural parents, explicit Back/Cancel targets,
  validators and renderer keys. Authorization runs through one action pipeline.
- `go`, `back`, `home`, `cancel` and `refresh` prepare an operation before effects.
  The previous screen remains current until rendering and completion succeed.
- Stage receipts retain partial renders. Confirmed effects can be recovered;
  unknown sends are not repeated automatically. Explicit refresh can select a
  new presentation operation, while unknown business cancellation stays guarded.
- `track` adopts an existing successful render. For recoverable application screen
  helpers, use `prepare_render` before sending and `complete_render` afterward.
- Accepted activity is explicit through navigation actions or `touch`; background
  renders can preserve the activity clock. Absolute session expiry never slides.
- Opaque callbacks bind actor, conversation, session and view. Localized reply
  text and bare commands act on current state and cannot prove an old origin.
- Dispatcher middleware protects the whole handler and shares verified FSM
  isolation. Binding routers precede business routers; Dispatcher root handlers
  must not outrank installed navigation bindings.

See [quickstart](docs/quickstart.md), [public API](docs/public-api.md),
[migration](docs/migration.md), [storage](docs/storage.md) and
[verification](docs/verification.md). The [memory audit](docs/memory-audit.md) records
concurrency, callback and FSM review corrections.

## Boundaries

Memory storage supports one event loop/process and loses everything on restart.
Application FSM state, authorization and business drafts remain application-owned.
A stage recorder cannot make Telegram and a database transactional.

The optional navigation/idle adapter lives in
`aiogram_idle.integrations.nav`; adopting it is explicit and does not add an idle
dependency to this package. See [optional integration](docs/idle-integration.md).
Multiple simultaneous panels and durable analytics remain deferred.

## Development

```sh
uv sync --extra redis
uv run --no-sync ruff check .
uv run --no-sync ruff format --check .
uv run --no-sync pyright src examples
uv run --no-sync pytest
# Full coverage including real Redis (see docs/redis.md):
AIOGRAM_NAV_REDIS_URL=redis://localhost:6379/0 AIOGRAM_NAV_REQUIRE_REDIS=1 uv run --extra redis pytest --cov=aiogram_nav --cov-report=term-missing
uv run --no-sync mkdocs build --strict
uv build
uv run --no-sync twine check dist/*
```

See [CONTRIBUTING.md](CONTRIBUTING.md) for repository conventions and verification,
[SECURITY.md](SECURITY.md) for vulnerability reporting, and
[release guidance](docs/releasing.md) for maintainer procedures.

MIT licensed. See [LICENSE](LICENSE).
