Skip to content

docs: add Quick Start guide #13

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.

Sign up for GitHub

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

Open
okwn wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add Quick Start guide #13

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,21 @@
# Agentmail Python Library


## Quick Start

Install with:
```bash
pip install agentmail-python
Copy link
Copy Markdown

@cubic-dev-ai cubic-dev-ai Bot May 23, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1: Quick Start uses incorrect package name agentmail-python instead of the documented agentmail

Prompt for AI agents 
Check if this issue is valid — if so, understand the root cause and fix it. At README.md, line 8:

<comment>Quick Start uses incorrect package name `agentmail-python` instead of the documented `agentmail`</comment>

<file context>
@@ -1,5 +1,21 @@
+
+Install with:
+```bash
+pip install agentmail-python
+```
+
</file context>
Suggested change
pip install agentmail-python
pip install agentmail
Fix with Cubic

```

Or clone and run:
```bash
git clone https://github.com/agentmail-to/agentmail-python.git
cd agentmail-python
python setup.py install
Copy link
Copy Markdown

@cubic-dev-ai cubic-dev-ai Bot May 23, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2: Quick Start documentation references python setup.py install but the repository has no setup.py file (only pyproject.toml with Poetry). This command will fail for users following the instructions.

Prompt for AI agents 
Check if this issue is valid — if so, understand the root cause and fix it. At README.md, line 15:

<comment>Quick Start documentation references `python setup.py install` but the repository has no `setup.py` file (only `pyproject.toml` with Poetry). This command will fail for users following the instructions.</comment>

<file context>
@@ -1,5 +1,21 @@
+```bash
+git clone https://github.com/agentmail-to/agentmail-python.git
+cd agentmail-python
+python setup.py install
+```
+
</file context>
Fix with Cubic

```


[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Fagentmail-to%2Fagentmail-python)
[![pypi](https://img.shields.io/pypi/v/agentmail)](https://pypi.python.org/pypi/agentmail)

Expand Down