Skip to content

Commit 5b42bfc

Browse files
authored
Plugin has been renamed
Closes simonw#31
1 parent 9d933ff commit 5b42bfc

File tree

1 file changed

+4
-63
lines changed

1 file changed

+4
-63
lines changed

README.md

Lines changed: 4 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -1,68 +1,9 @@
11
# llm-claude-3
22

3-
[![PyPI](https://img.shields.io/pypi/v/llm-claude-3.svg)](https://pypi.org/project/llm-claude-3/)
4-
[![Changelog](https://img.shields.io/github/v/release/simonw/llm-claude-3?include_prereleases&label=changelog)](https://github.com/simonw/llm-claude-3/releases)
5-
[![Tests](https://github.com/simonw/llm-claude-3/actions/workflows/test.yml/badge.svg)](https://github.com/simonw/llm-claude-3/actions/workflows/test.yml)
6-
[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/simonw/llm-claude-3/blob/main/LICENSE)
3+
**This plugin has been renamed to [llm-anthropic](https://github.com/simonw/llm-anthropic)**. You should install that instead:
74

8-
LLM access to Claude 3 by Anthropic
5+
llm install llm-anthropic
96

10-
## Installation
7+
Installing `llm-claude-3` will cause that plugin to be installed instead.
118

12-
Install this plugin in the same environment as [LLM](https://llm.datasette.io/).
13-
```bash
14-
llm install llm-claude-3
15-
```
16-
17-
## Usage
18-
19-
First, set [an API key](https://console.anthropic.com/settings/keys) for Claude 3:
20-
```bash
21-
llm keys set claude
22-
# Paste key here
23-
```
24-
25-
You can also set the key in the environment variable `ANTHROPIC_API_KEY`
26-
27-
Run `llm models` to list the models, and `llm models --options` to include a list of their options.
28-
29-
Run prompts like this:
30-
```bash
31-
llm -m claude-3.5-sonnet 'Fun facts about pelicans'
32-
llm -m claude-3.5-haiku 'Fun facts about armadillos'
33-
llm -m claude-3-opus 'Fun facts about squirrels'
34-
```
35-
Images are supported too:
36-
```bash
37-
llm -m claude-3.5-sonnet 'describe this image' -a https://static.simonwillison.net/static/2024/pelicans.jpg
38-
llm -m claude-3-haiku 'extract text' -a page.png
39-
```
40-
41-
## Development
42-
43-
To set up this plugin locally, first checkout the code. Then create a new virtual environment:
44-
```bash
45-
cd llm-claude-3
46-
python3 -m venv venv
47-
source venv/bin/activate
48-
```
49-
Now install the dependencies and test dependencies:
50-
```bash
51-
llm install -e '.[test]'
52-
```
53-
To run the tests:
54-
```bash
55-
pytest
56-
```
57-
58-
This project uses [pytest-recording](https://github.com/kiwicom/pytest-recording) to record Anthropic API responses for the tests.
59-
60-
If you add a new test that calls the API you can capture the API response like this:
61-
```bash
62-
PYTEST_ANTHROPIC_API_KEY="$(llm keys get claude)" pytest --record-mode once
63-
```
64-
You will need to have stored a valid Anthropic API key using this command first:
65-
```bash
66-
llm keys set claude
67-
# Paste key here
68-
```
9+
Here's [the README](https://github.com/simonw/llm-claude-3/blob/0.10/README.md) for the last release of this package, version 0.10.

0 commit comments

Comments
 (0)