andre/crewAI
1
0
Fork 0
mirror of https://github.com/crewAIInc/crewAI.git synced 2026-01-07 23:28:30 +00:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity

feat: update docs on Poetry -> uv

Browse Source
This commit is contained in:
Eduardo Chiarotti
2024-10-08 16:38:27 -03:00
parent 3f1b86d7aa
commit 7cd68183f7
11 changed files with 55 additions and 7387 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@@ -44,12 +44,12 @@ To get started with CrewAI, follow these simple steps:
### 1. Installation
Ensure you have Python >=3.10 <=3.13 installed on your system. CrewAI uses [Poetry](https://python-poetry.org/) for dependency management and package handling, offering a seamless setup and execution experience.
Ensure you have Python >=3.10 <=3.13 installed on your system. CrewAI uses [UV](https://docs.astral.sh/uv/) for dependency management and package handling, offering a seamless setup and execution experience.
First, if you haven't already, install Poetry:
First, if you haven't already, install uv:
```bash
pip install poetry
pip install uv
```
Then, install CrewAI:
@@ -332,14 +332,14 @@ CrewAI is open-source and we welcome contributions. If you're looking to contrib
### Installing Dependencies
```bash
poetry lock
poetry install
uv lock
uv sync
```
### Virtual Env
```bash
poetry shell
uv venv
```
### Pre-commit hooks
@@ -351,19 +351,19 @@ pre-commit install
### Running Tests
```bash
poetry run pytest
uvx pytest
```
### Running static type checks
```bash
poetry run mypy
uvx mypy
```
### Packaging
```bash
poetry build
uv build
```
### Installing Locally

4
docs/core-concepts/Cli.md
View File

@@ -4,10 +4,10 @@ The CrewAI CLI provides a set of commands to interact with CrewAI, allowing you
## Installation
To use the CrewAI CLI, make sure you have CrewAI & Poetry installed:
To use the CrewAI CLI, make sure you have CrewAI installed:
```
pip install crewai poetry
pip install crewai
```
## Basic Usage

8
docs/core-concepts/Flows.md
View File

@@ -543,16 +543,16 @@ In this example, the `PoemFlow` class defines a flow that generates a sentence c
### Running the Flow
Before running the flow, make sure to install the dependencies by running:
(Optional) Before running the flow, you can install the dependencies by running:
```bash
poetry install
crewai install
```
Once all of the dependencies are installed, you need to activate the virtual environment by running:
```bash
poetry shell
source .venv/bin/activate
```
After activating the virtual environment, you can run the flow by executing one of the following commands:
@@ -564,7 +564,7 @@ crewai flow run
or
```bash
poetry run run_flow
uv run run_flow
```
The flow will execute, and you should see the output in the console.

8
docs/getting-started/Create-a-New-CrewAI-Pipeline-Template-Method.md
View File

@@ -35,7 +35,7 @@ These commands will create a new project folder with the following structure:
```
<project_name>/
├── README.md
├── poetry.lock
├── uv.lock
├── pyproject.toml
├── src/
│ └── <project_name>/
@@ -139,11 +139,11 @@ The main annotation you'll use for pipelines is `@PipelineBase`. This annotation
## Installing Dependencies
To install the dependencies for your project, use Poetry:
To install the dependencies for your project, use `uv` the install command is optional because when running `crewai run`, it will automatically install the dependencies for you:
```shell
$ cd <project_name>
$ crewai install
$ crewai install (optional)
```
## Running Your Pipeline Project
@@ -160,4 +160,4 @@ This will initialize your pipeline and begin task execution as defined in your `
Pipelines can be deployed in the same way as regular CrewAI projects. The easiest way is through [CrewAI+](https://www.crewai.com/crewaiplus), where you can deploy your pipeline in a few clicks.
Remember, when working with pipelines, you're orchestrating multiple crews to work together in a sequence or parallel fashion. This allows for more complex workflows and information processing tasks.
Remember, when working with pipelines, you're orchestrating multiple crews to work together in a sequence or parallel fashion. This allows for more complex workflows and information processing tasks.

6
docs/getting-started/Start-a-New-CrewAI-Project-Template-Method.md
View File

@@ -24,7 +24,7 @@ $ pip install 'crewai[tools]'
## Creating a New Project
In this example, we will be using poetry as our virtual environment manager.
In this example, we will be using `uv` as our virtual environment manager.
To create a new CrewAI project, run the following CLI command:
@@ -163,11 +163,11 @@ def email_summarizer_task(self) -> Task:
## Installing Dependencies
To install the dependencies for your project, you can use Poetry. First, navigate to your project directory:
To install the dependencies for your project, you can use `uv`. Running the following command is optional since when running `crewai run`, it will automatically install the dependencies for you.
```shell
$ cd my_project
$ crewai install
$ crewai install (optional)
```
This will install the dependencies specified in the `pyproject.toml` file.

7353
poetry.lock generated
View File

File diff suppressed because it is too large Load Diff

24
pyproject.toml
View File

@@ -30,10 +30,19 @@ dependencies = [
"uv>=0.4.18",
]
[project.urls]
Homepage = "https://crewai.com"
Documentation = "https://docs.crewai.com"
Repository = "https://github.com/crewAIInc/crewAI"
[project.optional-dependencies]
tools = ["crewai-tools>=0.12.1"]
agentops = ["agentops>=0.3.0"]
[tool.uv]
dev-dependencies = [
"ruff>=0.4.10",
"mypy>=1.10.0",
"autoflake>=2.2.1",
"pre-commit>=3.6.0",
"mkdocs>=1.4.3",
"mkdocstrings>=0.22.0",
@@ -43,11 +52,24 @@ dev-dependencies = [
"pillow>=10.2.0",
"cairosvg>=2.7.1",
"crewai-tools>=0.12.1",
"pytest>=8.0.0",
"pytest-vcr>=1.0.2",
"python-dotenv>=1.0.0",
"pytest-asyncio>=0.23.7",
"pytest-subprocess>=1.5.2",
]
[project.scripts]
crewai = "crewai.cli.cli:crewai"
[tool.mypy]
ignore_missing_imports = true
disable_error_code = 'import-untyped'
exclude = ["cli/templates"]
[tool.bandit]
exclude_dirs = ["src/crewai/cli/templates"]
[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

2
src/crewai/cli/install_crew.py
View File

@@ -5,7 +5,7 @@ import click
def install_crew() -> None:
"""
Install the crew by running the Poetry command to lock and install.
Install the crew by running the UV command to lock and install.
"""
try:
subprocess.run(["uv", "sync"], check=True, capture_output=False, text=True)

2
src/crewai/cli/run_crew.py
View File

@@ -5,7 +5,7 @@ import click
def run_crew() -> None:
"""
Run the crew by running a command in the Poetry environment.
Run the crew by running a command in the UV environment.
"""
command = ["uv", "run", "run_crew"]

8
src/crewai/cli/templates/crew/README.md
View File

@@ -4,17 +4,17 @@ Welcome to the {{crew_name}} Crew project, powered by [crewAI](https://crewai.co
## Installation
Ensure you have Python >=3.10 <=3.13 installed on your system. This project uses [Poetry](https://python-poetry.org/) for dependency management and package handling, offering a seamless setup and execution experience.
Ensure you have Python >=3.10 <=3.13 installed on your system. This project uses [UV](https://docs.astral.sh/uv/) for dependency management and package handling, offering a seamless setup and execution experience.
First, if you haven't already, install Poetry:
First, if you haven't already, install uv:
```bash
pip install poetry
pip install uv
```
Next, navigate to your project directory and install the dependencies:
1. First lock the dependencies and install them by using the CLI command:
(Optional) Lock the dependencies and install them by using the CLI command:
```bash
crewai install
```

9
src/crewai/cli/templates/flow/README.md
View File

@@ -4,18 +4,17 @@ Welcome to the {{crew_name}} Crew project, powered by [crewAI](https://crewai.co
## Installation
Ensure you have Python >=3.10 <=3.13 installed on your system. This project uses [Poetry](https://python-poetry.org/) for dependency management and package handling, offering a seamless setup and execution experience.
Ensure you have Python >=3.10 <=3.13 installed on your system. This project uses [UV](https://docs.astral.sh/uv/) for dependency management and package handling, offering a seamless setup and execution experience.
First, if you haven't already, install Poetry:
First, if you haven't already, install uv:
```bash
pip install poetry
pip install uv
```
Next, navigate to your project directory and install the dependencies:
1. First lock the dependencies and then install them:
(Optional) Lock the dependencies and install them by using the CLI command:
```bash
crewai install
```