Python: organize packages in package directory (#420)

* Move packages to packages directory

* remove screenshot

* update some paths

.github/workflows/checks.yml

@@ -14,7 +14,7 @@ jobs:
     strategy:
       matrix:
         working-directory:
-          ["./python", "./python/teams/team-one", "./python/tools/agbench"]
+          ["./python/packages/autogen-core", "./python/packages/team-one", "./python/packages/agbench"]
     steps:
       - uses: actions/checkout@v4
       - name: Install Hatch
@@ -27,7 +27,7 @@ jobs:
     strategy:
       matrix:
         working-directory:
-          ["./python", "./python/teams/team-one", "./python/tools/agbench"]
+          ["./python/packages/autogen-core", "./python/packages/team-one", "./python/packages/agbench"]
     steps:
       - uses: actions/checkout@v4
       - name: Install Hatch
@@ -40,7 +40,7 @@ jobs:
     strategy:
       matrix:
         working-directory:
-          ["./python", "./python/teams/team-one", "./python/tools/agbench"]
+          ["./python/packages/autogen-core", "./python/packages/team-one", "./python/packages/agbench"]
     steps:
       - uses: actions/checkout@v4
       - name: Install Hatch
@@ -53,7 +53,7 @@ jobs:
     strategy:
       matrix:
         working-directory:
-          ["./python", "./python/teams/team-one", "./python/tools/agbench"]
+          ["./python/packages/autogen-core", "./python/packages/team-one", "./python/packages/agbench"]
     steps:
       - uses: actions/checkout@v4
       - name: Install Hatch
@@ -71,7 +71,7 @@ jobs:
       - name: Install Hatch
         uses: pypa/hatch@install
       - run: hatch run +python=${{ matrix.python-version }} test-matrix:pytest -n auto
-        working-directory: ./python
+        working-directory: ./python/packages/autogen-core
 
   team-one-test:
     runs-on: ubuntu-latest
@@ -85,7 +85,7 @@ jobs:
       - run: |
           hatch run +python=${{ matrix.python-version }} teamone-test-matrix:playwright install
           hatch run +python=${{ matrix.python-version }} teamone-test-matrix:pytest -n auto
-        working-directory: ./python/teams/team-one
+        working-directory: ./python/packages/team-one
 
   mypy-notebooks:
     runs-on: ubuntu-latest
@@ -94,7 +94,7 @@ jobs:
       - name: Install Hatch
         uses: pypa/hatch@install
       - run: hatch run nbqa mypy docs/src
-        working-directory: ./python
+        working-directory: ./python/packages/autogen-core
 
   docs:
     runs-on: ubuntu-latest
@@ -103,4 +103,4 @@ jobs:
       - name: Install Hatch
         uses: pypa/hatch@install
       - run: hatch run docs:check
-        working-directory: ./python
+        working-directory: ./python/packages/autogen-core

python/README.md

@@ -1,61 +1,3 @@
-# AGNext
+# AutoGen Python packages
 
-- [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.
+See [`autogen-core`](./packages/autogen-core/) package for main functionality.

python/packages/autogen-core/.gitignore

@@ -0,0 +1,174 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+.ruff_cache/
+
+/docs/src/reference
+.DS_Store
+
+# Generated log files
+log.jsonl
+
+# Jupyter notebooks executions in docs.
+docs/**/jupyter_execute
+
+# Temporary files
+tmp_code_*.py

python/packages/autogen-core/README.md

@@ -0,0 +1,61 @@
+# AutoGen Core
+
+- [Documentation](http://microsoft.github.io/agnext)
+- [Examples](https://github.com/microsoft/agnext/tree/main/python/samples)
+
+## Package layering
+
+- `base` 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.