mirror of
https://github.com/microsoft/autogen.git
synced 2026-01-25 10:28:04 -05:00
622b4e38e1
Update Python Readme with steps to make hatch work in IntelliJ-class IDEs. For people like me to not waste time on figuring this out. Co-authored-by: Eric Zhu <ekzhu@users.noreply.github.com>
62 lines
1.6 KiB
Markdown
62 lines
1.6 KiB
Markdown
# AGNext
|
|
|
|
- [Documentation](http://microsoft.github.io/agnext)
|
|
- [Examples](https://github.com/microsoft/agnext/tree/main/python/samples)
|
|
|
|
## 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:
|
|
|
|
```sh
|
|
hatch run check
|
|
```
|
|
|
|
### Setup
|
|
|
|
- [Install `hatch`](https://hatch.pypa.io/1.12/install/).
|
|
|
|
### Virtual environment
|
|
|
|
To get a shell with the package available (virtual environment),
|
|
in the current directory,
|
|
run:
|
|
|
|
```sh
|
|
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:
|
|
|
|
```toml
|
|
[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.
|