docs: add README and description for crewai-files package

This commit is contained in:
Greyson LaLonde
2026-01-22 22:50:10 -05:00
parent 2c5e794ea3
commit 8be27da9ff
3 changed files with 45 additions and 5 deletions

View File

@@ -0,0 +1,43 @@
# crewai-files
File handling utilities for CrewAI multimodal inputs.
## Supported File Types
- `ImageFile` - PNG, JPEG, GIF, WebP
- `PDFFile` - PDF documents
- `TextFile` - Plain text files
- `AudioFile` - MP3, WAV, FLAC, OGG, M4A
- `VideoFile` - MP4, WebM, MOV, AVI
## Usage
```python
from crewai_files import File, ImageFile, PDFFile
# Auto-detect file type
file = File(source="document.pdf") # Resolves to PDFFile
# Or use specific types
image = ImageFile(source="chart.png")
pdf = PDFFile(source="report.pdf")
```
### Passing Files to Crews
```python
crew.kickoff(inputs={
"files": {"chart": ImageFile(source="chart.png")}
})
```
### Passing Files to Tasks
```python
task = Task(
description="Analyze the chart",
expected_output="Analysis",
agent=agent,
input_files=[ImageFile(source="chart.png")],
)
```

View File

@@ -1,7 +1,7 @@
[project]
name = "crewai-files"
dynamic = ["version"]
description = "Add your description here"
description = "File handling utilities for CrewAI multimodal inputs"
readme = "README.md"
authors = [
{ name = "Greyson LaLonde", email = "greyson@crewai.com" }

View File

@@ -3,7 +3,7 @@
from __future__ import annotations
import logging
from typing import Literal, TypeAlias, TypedDict, overload
from typing import Any as AnyType, Literal, TypeAlias, TypedDict, overload
from typing_extensions import NotRequired, Unpack
@@ -36,9 +36,6 @@ ProviderType: TypeAlias = (
)
from typing import Any as AnyType
class _BaseOpts(TypedDict):
"""Kwargs for uploader factory."""