Eric Zhu 87c00a554d Core concept doc refactor and add documentation for topic and subscription (#414)
* Refactor core concept docs and add new ones for agent identity and topic subscription.

* update notebook

* update notebook

* resolve conflict

* fix link

* fix ref

* update notebook

* update notebook
2024-08-28 01:09:28 -07:00
..
2024-08-27 17:04:22 -04:00
2024-08-19 20:32:34 +00:00
2024-08-01 21:07:43 +00:00

AGNext

Package layering

  • core are the the foundational generic interfaces upon which all else is built. This module must not depend on any other module.
  • application are implementations of core components that are used to compose an application.
  • components are the building blocks for creating agents.

Development

TL;DR, run all checks with:

hatch run check

Setup

Virtual environment

To get a shell with the package available (virtual environment), in the current directory, run:

hatch shell

Common tasks

  • Format: hatch run check
  • Lint: hatch run lint
  • Test: hatch run pytest -n auto
  • Mypy: hatch run mypy
  • Pyright: hatch run pyright
  • Build docs: hatch run docs:build
  • Auto rebuild+serve docs: hatch run docs:serve

Note

These don't need to be run in a virtual environment, hatch will automatically manage it for you.

IntelliJ Support

To enable the hatch virtual environment in IntelliJ, follow these steps: Under the [tool.hatch.envs.default] heading in pyproject.toml, add this:

[tool.hatch.envs.default]
type = "virtual"
path = ".venv"

Run hatch shell in the terminal to create the virtual environment.

Then, in IntelliJ, go to File -> Project Structure -> Project Settings -> Project -> Project SDK and select the Python interpreter in the .venv directory.

Once complete, your IDE should be able to resolve, run, and debug code.