-
Notifications
You must be signed in to change notification settings - Fork 1k
Add initial skeleton of package, including tooling setup and CI #4
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| name: Check Python | ||
| on: | ||
| workflow_dispatch: | ||
| pull_request: | ||
| branches: ["main"] | ||
| paths: | ||
| - "python/**" | ||
| - ".github/workflows/check-python.yml" | ||
|
|
||
| jobs: | ||
| pre-commit: | ||
| if: "!cancelled()" | ||
| strategy: | ||
| fail-fast: false | ||
| matrix: | ||
| python-version: ["3.10"] | ||
| runs-on: ubuntu-latest | ||
| continue-on-error: true | ||
| defaults: | ||
| run: | ||
| working-directory: python | ||
| env: | ||
| # Configure a constant location for the uv cache | ||
| UV_CACHE_DIR: /tmp/.uv-cache | ||
| UV_PYTHON: ${{ matrix.python-version }} | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - name: Set up uv | ||
| uses: astral-sh/setup-uv@v5 | ||
| with: | ||
| version: "0.7.x" | ||
| enable-cache: true | ||
| cache-suffix: ${{ runner.os }}-${{ matrix.python-version }} | ||
| cache-dependency-glob: "**/uv.lock" | ||
| - name: Install the project | ||
| run: uv sync --all-extras --dev | ||
| - uses: pre-commit/[email protected] | ||
| name: Run Pre-Commit Hooks | ||
| with: | ||
| extra_args: --config python/.pre-commit-config.yaml --all-files |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 | ||
|
|
||
| # UV | ||
| # Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control. | ||
| # This is especially recommended for binary packages to ensure reproducibility, and is more | ||
| # commonly ignored for libraries. | ||
| #uv.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/latest/usage/project/#working-with-version-control | ||
| .pdm.toml | ||
| .pdm-python | ||
| .pdm-build/ | ||
|
|
||
| # 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 stuff: | ||
| .ruff_cache/ | ||
|
|
||
| # PyPI configuration file | ||
| .pypirc |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| fail_fast: true | ||
| repos: | ||
| - repo: https://github.com/pre-commit/pre-commit-hooks | ||
| rev: v4.6.0 | ||
| hooks: | ||
| - id: check-toml | ||
| files: \.toml$ | ||
| - id: check-yaml | ||
| files: \.yaml$ | ||
| - id: check-json | ||
| files: \.json$ | ||
| - id: end-of-file-fixer | ||
| files: \.py$ | ||
| - id: mixed-line-ending | ||
| files: \.py$ | ||
| - id: check-ast | ||
| name: Check Valid Python Samples | ||
| types: ["python"] | ||
| - repo: https://github.com/nbQA-dev/nbQA | ||
| rev: 1.8.5 | ||
| hooks: | ||
| - id: nbqa-check-ast | ||
| name: Check Valid Python Notebooks | ||
| types: ["jupyter"] | ||
| - repo: https://github.com/asottile/pyupgrade | ||
| rev: v3.17.0 | ||
| hooks: | ||
| - id: pyupgrade | ||
| args: [--py310-plus] | ||
| - repo: https://github.com/astral-sh/ruff-pre-commit | ||
| rev: v0.9.6 | ||
| hooks: | ||
| - id: ruff | ||
| args: [ --fix, --exit-non-zero-on-fix ] | ||
| - id: ruff-format | ||
| - repo: https://github.com/astral-sh/uv-pre-commit | ||
| # uv version. | ||
| rev: 0.7.2 | ||
| hooks: | ||
| # Update the uv lockfile | ||
| - id: uv-lock | ||
| files: python/pyproject.toml | ||
| args: [--project, python] | ||
| - repo: https://github.com/RobertCraigie/pyright-python | ||
jackgerrits marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| rev: v1.1.400 | ||
| hooks: | ||
| - id: pyright | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| 3.10 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| MIT License | ||
|
|
||
| Copyright (c) Microsoft Corporation. | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| # Python | ||
|
|
||
| ## Checks | ||
|
|
||
| Run all checks using pre-commit: | ||
|
|
||
| ```bash | ||
| uv run pre-commit run -a | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| [project] | ||
| name = "agent-framework" | ||
| readme = "README.md" | ||
| requires-python = ">=3.10" | ||
| version = "0.0.0" | ||
| license = {file = "LICENSE"} | ||
| urls.source = "https://github.com/microsoft/agent-framework/tree/main/python" | ||
| dependencies = [ | ||
| ] | ||
|
|
||
| [dependency-groups] | ||
| dev = [ | ||
| "pre-commit >= 3.7", | ||
| "pyright>=1.1.400", | ||
| "mypy>=1.15.0", | ||
| "ruff>=0.11.8", | ||
| ] | ||
|
|
||
| [build-system] | ||
| requires = ["hatchling", "uv-dynamic-versioning"] | ||
| build-backend = "hatchling.build" | ||
|
|
||
|
|
||
| [tool.uv-dynamic-versioning] | ||
| fallback-version = "0.0.0" | ||
|
|
||
| [tool.ruff] | ||
| line-length = 120 | ||
| target-version = "py310" | ||
| include = ["*.py", "*.pyi", "**/pyproject.toml", "*.ipynb"] | ||
| preview = true | ||
|
|
||
| [tool.ruff.lint] | ||
| fixable = ["ALL"] | ||
| unfixable = [] | ||
| select = [ | ||
| "ASYNC", # async checks | ||
| "B", # bugbear checks | ||
| "CPY", # copyright | ||
| "D", # pydocstyle checks | ||
| "E", # pycodestyle error checks | ||
| "ERA", # remove connected out code | ||
| "F", # pyflakes checks | ||
| "FIX", # fixme checks | ||
| "I", # isort | ||
| "INP", # implicit namespace package | ||
| "ISC", # implicit string concat | ||
| "Q", # flake8-quotes checks | ||
| "RET", # flake8-return check | ||
| "RSE", # raise exception parantheses check | ||
| "RUF", # RUF specific rules | ||
| "SIM", # flake8-simplify check | ||
| "T20", # typing checks | ||
| "TD", # todos | ||
| "W", # pycodestyle warning checks | ||
| "T100", # Debugger, | ||
| "S", # Bandit checks | ||
| ] | ||
| ignore = [ | ||
| "D100", # allow missing docstring in public module | ||
| "D104", # allow missing docstring in public package | ||
| "TD003", # allow missing link to todo issue | ||
| "FIX002" # allow todo | ||
| ] | ||
|
|
||
| [tool.ruff.format] | ||
| docstring-code-format = true | ||
|
|
||
| [tool.ruff.lint.pydocstyle] | ||
| convention = "google" | ||
|
|
||
| [tool.ruff.lint.flake8-copyright] | ||
| notice-rgx = "^# Copyright \\(c\\) Microsoft\\. All rights reserved\\." | ||
| min-file-size = 1 | ||
|
|
||
| [tool.pyright] | ||
| include = ["src", "tests", "samples"] | ||
| typeCheckingMode = "strict" | ||
| reportUnnecessaryIsInstance = false | ||
| reportMissingTypeStubs = false | ||
| venvPath = "." | ||
| venv = ".venv" | ||
|
|
||
| [tool.mypy] | ||
| strict = true | ||
| python_version = "3.9" | ||
| ignore_missing_imports = true | ||
|
|
||
| disallow_untyped_defs = true | ||
| no_implicit_optional = true | ||
| check_untyped_defs = true | ||
| warn_return_any = true | ||
| show_error_codes = true | ||
| warn_unused_ignores = false | ||
|
|
||
| disallow_incomplete_defs = true | ||
| disallow_untyped_decorators = true | ||
| disallow_any_unimported = true |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.