From 0816370b1adb02f9def5bf1f882fc8e6b5232525 Mon Sep 17 00:00:00 2001 From: mrT23 Date: Fri, 22 Mar 2024 20:11:26 +0200 Subject: [PATCH] adjustments to pypi --- MANIFEST.in | 2 ++ README.md | 65 ++++++++++++++++++------------------ pr_agent/servers/__init__.py | 0 pyproject.toml | 28 ++++++++-------- requirements.txt | 10 +++--- 5 files changed, 55 insertions(+), 50 deletions(-) create mode 100644 MANIFEST.in create mode 100644 pr_agent/servers/__init__.py diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 00000000..ccb17336 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,2 @@ +recursive-include pr_agent *.toml +recursive-exclude pr_agent *.secrets.toml \ No newline at end of file diff --git a/README.md b/README.md index ad3c0407..80cde6f2 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,8 @@ - logo + logo +
Making pull requests less painful with an AI agent @@ -59,7 +60,7 @@ If set to true, the tool will add a section that checks if the PR contains sever ## Overview
-CodiumAI PR-Agent is an open-source tool to help efficiently review and handle pull requests. +CodiumAI PR-Agent aims to help efficiently review and handle pull requests, by providing AI feedbacks and suggestions - See the [Installation Guide](https://pr-agent-docs.codium.ai/installation/) for instructions on installing and running the tool on different git platforms. @@ -71,38 +72,38 @@ Supported commands per platform: | | | GitHub | Gitlab | Bitbucket | Azure DevOps | |-------|-------------------------------------------------------------------------------------------------------------------|:--------------------:|:--------------------:|:--------------------:|:--------------------:| -| TOOLS | Review | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | -| | ⮑ Incremental | :white_check_mark: | | | | -| | ⮑ [SOC2 Compliance](https://pr-agent-docs.codium.ai/tools/review/#soc2-ticket-compliance) 💎 | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | -| | Describe | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | -| | ⮑ [Inline File Summary](https://pr-agent-docs.codium.ai/tools/describe#inline-file-summary) 💎 | :white_check_mark: | | | | -| | Improve | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | -| | ⮑ Extended | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | -| | Ask | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | -| | ⮑ [Ask on code lines](https://pr-agent-docs.codium.ai/tools/ask#ask-lines) | :white_check_mark: | :white_check_mark: | | | -| | [Custom Suggestions](https://pr-agent-docs.codium.ai/tools/custom_suggestions/) 💎 | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | -| | [Test](https://pr-agent-docs.codium.ai/tools/test/) 💎 | :white_check_mark: | :white_check_mark: | | :white_check_mark: | -| | Reflect and Review | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | -| | Update CHANGELOG.md | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | -| | Find Similar Issue | :white_check_mark: | | | | -| | [Add PR Documentation](https://pr-agent-docs.codium.ai/tools/documentation/) 💎 | :white_check_mark: | :white_check_mark: | | :white_check_mark: | -| | [Custom Labels](https://pr-agent-docs.codium.ai/tools/custom_labels/) 💎 | :white_check_mark: | :white_check_mark: | | :white_check_mark: | -| | [Analyze](https://pr-agent-docs.codium.ai/tools/analyze/) 💎 | :white_check_mark: | :white_check_mark: | | :white_check_mark: | -| | [CI Feedback](https://pr-agent-docs.codium.ai/tools/ci_feedback/) 💎 | :white_check_mark: | | | | -| | [Similar Code](https://pr-agent-docs.codium.ai/tools/similar_code/) 💎 | :white_check_mark: | | | | +| TOOLS | Review | ✅ | ✅ | ✅ | ✅ | +| | ⮑ Incremental | ✅ | | | | +| | ⮑ [SOC2 Compliance](https://pr-agent-docs.codium.ai/tools/review/#soc2-ticket-compliance) 💎 | ✅ | ✅ | ✅ | ✅ | +| | Describe | ✅ | ✅ | ✅ | ✅ | +| | ⮑ [Inline File Summary](https://pr-agent-docs.codium.ai/tools/describe#inline-file-summary) 💎 | ✅ | | | | +| | Improve | ✅ | ✅ | ✅ | ✅ | +| | ⮑ Extended | ✅ | ✅ | ✅ | ✅ | +| | Ask | ✅ | ✅ | ✅ | ✅ | +| | ⮑ [Ask on code lines](https://pr-agent-docs.codium.ai/tools/ask#ask-lines) | ✅ | ✅ | | | +| | [Custom Suggestions](https://pr-agent-docs.codium.ai/tools/custom_suggestions/) 💎 | ✅ | ✅ | ✅ | ✅ | +| | [Test](https://pr-agent-docs.codium.ai/tools/test/) 💎 | ✅ | ✅ | | ✅ | +| | Reflect and Review | ✅ | ✅ | ✅ | ✅ | +| | Update CHANGELOG.md | ✅ | ✅ | ✅ | ✅ | +| | Find Similar Issue | ✅ | | | | +| | [Add PR Documentation](https://pr-agent-docs.codium.ai/tools/documentation/) 💎 | ✅ | ✅ | | ✅ | +| | [Custom Labels](https://pr-agent-docs.codium.ai/tools/custom_labels/) 💎 | ✅ | ✅ | | ✅ | +| | [Analyze](https://pr-agent-docs.codium.ai/tools/analyze/) 💎 | ✅ | ✅ | | ✅ | +| | [CI Feedback](https://pr-agent-docs.codium.ai/tools/ci_feedback/) 💎 | ✅ | | | | +| | [Similar Code](https://pr-agent-docs.codium.ai/tools/similar_code/) 💎 | ✅ | | | | | | | | | | | -| USAGE | CLI | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | -| | App / webhook | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | -| | Tagging bot | :white_check_mark: | | | | -| | Actions | :white_check_mark: | | :white_check_mark: | | +| USAGE | CLI | ✅ | ✅ | ✅ | ✅ | +| | App / webhook | ✅ | ✅ | ✅ | ✅ | +| | Tagging bot | ✅ | | | | +| | Actions | ✅ | | ✅ | | | | | | | | | -| CORE | PR compression | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | -| | Repo language prioritization | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | -| | Adaptive and token-aware file patch fitting | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | -| | Multiple models support | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | -| | [Static code analysis](https://pr-agent-docs.codium.ai/core-abilities/#static-code-analysis) 💎 | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | -| | [Global and wiki configurations](https://pr-agent-docs.codium.ai/usage-guide/configuration_options/) 💎 | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | -| | [PR interactive actions](https://www.codium.ai/images/pr_agent/pr-actions.mp4) 💎 | :white_check_mark: | | | | +| CORE | PR compression | ✅ | ✅ | ✅ | ✅ | +| | Repo language prioritization | ✅ | ✅ | ✅ | ✅ | +| | Adaptive and token-aware file patch fitting | ✅ | ✅ | ✅ | ✅ | +| | Multiple models support | ✅ | ✅ | ✅ | ✅ | +| | [Static code analysis](https://pr-agent-docs.codium.ai/core-abilities/#static-code-analysis) 💎 | ✅ | ✅ | ✅ | ✅ | +| | [Global and wiki configurations](https://pr-agent-docs.codium.ai/usage-guide/configuration_options/) 💎 | ✅ | ✅ | ✅ | ✅ | +| | [PR interactive actions](https://www.codium.ai/images/pr_agent/pr-actions.mp4) 💎 | ✅ | | | | - 💎 means this feature is available only in [PR-Agent Pro](https://www.codium.ai/pricing/) [//]: # (- Support for additional git providers is described in [here](./docs/Full_environments.md)) diff --git a/pr_agent/servers/__init__.py b/pr_agent/servers/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/pyproject.toml b/pyproject.toml index 37be93e3..f4be6371 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,44 +3,44 @@ requires = ["setuptools>=61.0"] build-backend = "setuptools.build_meta" [project] -name = "pr_agent" -version = "0.0.1" +name = "pr-agent" +version = "0.2.0" + +authors = [{name= "CodiumAI", email = "tal.r@codium.ai"}] -authors = [ - {name = "Itamar Friedman", email = "itamar.f@codium.ai"}, -] maintainers = [ - {name = "Ori Kotek", email = "ori.k@codium.ai"}, {name = "Tal Ridnik", email = "tal.r@codium.ai"}, + {name = "Ori Kotek", email = "ori.k@codium.ai"}, {name = "Hussam Lawen", email = "hussam.l@codium.ai"}, - {name = "Sagi Medina", email = "sagi.m@codium.ai"} ] -description = "CodiumAI PR-Agent is an open-source tool to automatically analyze a pull request and provide several types of feedback" + +description = "CodiumAI PR-Agent aims to help efficiently review and handle pull requests, by providing AI feedbacks and suggestions." readme = "README.md" requires-python = ">=3.10" -keywords = ["ai", "tool", "developer", "review", "agent"] -license = {file = "LICENSE", name = "Apache 2.0 License"} +keywords = ["AI", "Agents", "Pull Request", "Automation", "Code Review"] +license = {name = "Apache 2.0", file = "LICENSE"} + classifiers = [ - "Development Status :: 3 - Alpha", "Intended Audience :: Developers", - "Operating System :: Independent", "Programming Language :: Python :: 3", ] dynamic = ["dependencies"] + [tool.setuptools.dynamic] dependencies = {file = ["requirements.txt"]} [project.urls] "Homepage" = "https://github.com/Codium-ai/pr-agent" +"Documentation" = "https://pr-agent-docs.codium.ai/" [tool.setuptools] -include-package-data = false +include-package-data = true license-files = ["LICENSE"] [tool.setuptools.packages.find] where = ["."] -include = ["pr_agent"] +include = ["pr_agent*"] # include pr_agent and any sub-packages it finds under it. [project.scripts] pr-agent = "pr_agent.cli:run" diff --git a/requirements.txt b/requirements.txt index 97df2f93..924d2bb2 100644 --- a/requirements.txt +++ b/requirements.txt @@ -13,9 +13,6 @@ litellm==1.31.10 loguru==0.7.2 msrest==0.7.1 openai==1.13.3 -pinecone-client -pinecone-datasets @ git+https://github.com/mrT23/pinecone-datasets.git@main -lancedb==0.5.1 pytest==7.4.0 PyGithub==1.59.* PyYAML==6.0.1 @@ -26,4 +23,9 @@ tiktoken==0.5.2 ujson==5.8.0 uvicorn==0.22.0 tenacity==8.2.3 -# langchain==0.0.349 # uncomment this to support language LangChainOpenAIHandler +# Uncomment the following lines to enable the 'similar issue' tool +# pinecone-client +# pinecone-datasets @ git+https://github.com/mrT23/pinecone-datasets.git@main +# lancedb==0.5.1 +# uncomment this to support language LangChainOpenAIHandler +# langchain==0.0.349