Skip to content

Commit

Permalink
Move python code to subdir (microsoft#98)
Browse files Browse the repository at this point in the history
  • Loading branch information
jackgerrits authored Jun 20, 2024
1 parent c9e09e2 commit d365a58
Show file tree
Hide file tree
Showing 102 changed files with 57 additions and 51 deletions.
6 changes: 6 additions & 0 deletions .github/workflows/checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ jobs:
- name: Install Hatch
uses: pypa/hatch@install
- run: hatch run ruff format --check
working-directory: ./python

lint:
runs-on: ubuntu-latest
Expand All @@ -24,6 +25,7 @@ jobs:
- name: Install Hatch
uses: pypa/hatch@install
- run: hatch run ruff check
working-directory: ./python

mypy:
runs-on: ubuntu-latest
Expand All @@ -32,6 +34,7 @@ jobs:
- name: Install Hatch
uses: pypa/hatch@install
- run: hatch run mypy
working-directory: ./python

pyright:
runs-on: ubuntu-latest
Expand All @@ -40,6 +43,7 @@ jobs:
- name: Install Hatch
uses: pypa/hatch@install
- run: hatch run pyright
working-directory: ./python

test:
runs-on: ubuntu-latest
Expand All @@ -51,6 +55,7 @@ jobs:
- name: Install Hatch
uses: pypa/hatch@install
- run: hatch run +python=${{ matrix.python-version }} test-matrix:pytest -n auto
working-directory: ./python

docs:
runs-on: ubuntu-latest
Expand All @@ -59,3 +64,4 @@ jobs:
- name: Install Hatch
uses: pypa/hatch@install
- run: hatch run docs:check
working-directory: ./python
3 changes: 2 additions & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,11 @@ jobs:
- name: Install Hatch
uses: pypa/hatch@install
- run: hatch run docs:build
working-directory: ./python
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: 'docs/build'
path: 'python/docs/build'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
7 changes: 0 additions & 7 deletions .vscode/settings.json

This file was deleted.

47 changes: 4 additions & 43 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,45 +1,6 @@
# AutoGenNext
# AGNext

- [Documentation](http://microsoft.github.io/agnext)
- [Examples](https://github.com/microsoft/agnext/tree/main/examples)
See corresponding subdirectories for more information.


## Package layering

- `core` are the the foundational generic interfaces upon which all else is built. This module must not depend on any other module.
- `components` are the building blocks for creating single agents
- `application` are implementations of core components that are used to compose an application
- `chat` is the concrete implementation of multi-agent interactions. Most users will deal with this module.


## 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) 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.
- [Python Documentation](http://microsoft.github.io/agnext)
- [Python Examples](https://github.com/microsoft/agnext/tree/main/python/examples)
File renamed without changes.
45 changes: 45 additions & 0 deletions python/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# AGNext

- [Documentation](http://microsoft.github.io/agnext)
- [Examples](https://github.com/microsoft/agnext/tree/main/python/examples)


## Package layering

- `core` are the the foundational generic interfaces upon which all else is built. This module must not depend on any other module.
- `components` are the building blocks for creating single agents
- `application` are implementations of core components that are used to compose an application
- `chat` is the concrete implementation of multi-agent interactions. Most users will deal with this module.


## 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) 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.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit d365a58

Please sign in to comment.