# Add AIssue to a Django project

## Rules for the agent

- Make the smallest change that works. Do not refactor or reformat unrelated code.
- **Never** write the user's AIssue API token into a file, a commit, a log, or output you show. Keep it in a shell variable for this session only.
- Put the DSN in environment variables (`.env`, `.env.local`, the hosting provider's settings), not in committed code, except where a browser bundle needs it inline (the guide says when). Make sure `.env*` files are git-ignored.
- If the repository holds several applications, or the setup is unusual, ask the user which one to set up.
- If the project restricts new dependencies, ask before installing.


## Get the DSN

The DSN tells the SDK where to send errors. It looks like `https://<key>@aissue.dev/<number>`.

**If the user already gave you a DSN, use it and skip this section.**

Otherwise, ask the user:

> Please paste your AIssue API token. You can create one at https://aissue.dev/app/account/tokens.

Then, in the shell (the token stays in this session only):

```bash
export AISSUE_TOKEN='<the token the user gave you>'
curl -s https://aissue.dev/api/v1/domains -H "Authorization: Bearer $AISSUE_TOKEN"
```

- If one of the listed domains clearly belongs to this project, use its `id` and `dsn`.
- Otherwise create one, named after the project (for example the repository or package name):

```bash
curl -s -X POST https://aissue.dev/api/v1/domains \
  -H "Authorization: Bearer $AISSUE_TOKEN" -H "Content-Type: application/json" \
  -d '{"name": "<project name>"}'
```

The response contains the domain `id` and its `dsn`. If it says the plan's domain limit is reached, tell the user.


## Install

Add `aissue` to the project's dependency file (`requirements.txt`, `pyproject.toml`, Pipfile, …) the way the project already manages dependencies, then install it. With plain pip:

```bash
pip install aissue
```

## Configure

1. In the settings module that production uses (often `settings.py`, or `settings/base.py` when settings are split), append the middleware to `MIDDLEWARE`:

```python
MIDDLEWARE = [
    # ... keep the existing middleware
    "aissue.middleware.AIssueMiddleware",
]
```

2. Set the DSN as an environment variable. The middleware reads `AISSUE_DSN` from the environment by itself, so no settings line is needed:

```bash
AISSUE_DSN=<DSN>
```

   Put it where the project keeps environment variables: `.env` (if the project loads it, e.g. with django-environ or python-dotenv), `docker-compose.yml` `environment:`, or the hosting provider's settings. If the project reads settings explicitly instead, add `AISSUE_DSN = os.environ.get("AISSUE_DSN")` to the settings module.

3. Optional: also report errors that the code catches and logs (`logger.exception(...)`). Add a handler to the existing `LOGGING` setting, without replacing the existing handlers:

```python
"handlers": {
    # ... existing handlers
    "aissue": {"class": "aissue.logging.AIssueHandler", "level": "ERROR"},
},
# and add "aissue" to the handlers of the root logger (or the project's main logger)
```

Behaviour: unhandled view errors are reported only when `DEBUG = False`, in a background thread. `Http404` and `PermissionDenied` are not reported. Cookies, auth headers, request bodies and emails are never sent.

## Verification step

Run from the project directory, in the project's Python environment:

```bash
AISSUE_DSN='<DSN>' python - <<'PY'
import aissue
aissue.init()
try:
    raise RuntimeError("AIssue setup test")
except RuntimeError as exc:
    aissue.capture_exception(exc)
print("sent" if aissue.flush(10) else "not sent")
PY
```

## Verify that errors arrive

1. Send a test error with the command in the verification step above.
2. Check that it arrived (needs the API token; if you only have a DSN, ask the user to look at their AIssue dashboard instead):

```bash
curl -s "https://aissue.dev/api/v1/domains/<domain id>/events?limit=5" -H "Authorization: Bearer $AISSUE_TOKEN"
```

   Look for an event titled `RuntimeError: AIssue setup test` (or `Error: AIssue setup test`). It usually appears within a few seconds.
3. Resolve the test issue so it doesn't clutter the dashboard (`issue_id` is in the event):

```bash
curl -s -X POST https://aissue.dev/api/v1/issues/<issue_id>/resolve -H "Authorization: Bearer $AISSUE_TOKEN"
```

If nothing arrives, check:
- the DSN is exactly right;
- the environment variable is loaded where the command ran;
- the machine can reach `aissue.dev`;
- the SDK isn't disabled in development (the guide says how to enable it for the test).

## Finish

Tell the user:
- which files you changed;
- that `AISSUE_DSN` (and any other variables you added) must also be set in their **production** environment, for example in the hosting provider's dashboard;
- that errors are reported from production by default, not from local development.

**Recommend connecting GitHub.** AI analyses can then point at the exact file, line and commit. It needs the user in a browser:

```bash
curl -s https://aissue.dev/api/v1/domains/<domain id>/github -H "Authorization: Bearer $AISSUE_TOKEN"
```

Give the user the `connect_url` from that response.

**Deployed commit.** AIssue reads the exact deployed code when the SDK knows the git commit. This is automatic on Vercel, Render, Railway, Heroku, Cloudflare Pages and GitHub Actions. With Docker or other hosts, set `AISSUE_RELEASE` to the commit SHA at deploy time, for example `--build-arg AISSUE_RELEASE=$(git rev-parse HEAD)` plus `ENV AISSUE_RELEASE=$AISSUE_RELEASE` in the Dockerfile.
