@@ -97,21 +97,28 @@ modify existing files seamlessly.
9797 Installation
9898**************
9999
100- At present, we recommend installing Codescribe in a virtual
101- environment:
100+ Codescribe uses `` pyproject.toml `` to declare its build system and
101+ dependencies. We recommend installing in a virtual environment:
102102
103103.. code :: bash
104104
105105 python3 -m venv env
106106 source env/bin/activate
107107 pip install --upgrade pip
108108
109- And install Codescribe using ``pip `` in editable mode:
109+ Install Codescribe and its core dependencies using ``pip `` in editable
110+ mode:
110111
111112.. code :: bash
112113
113114 pip install -e .
114115
116+ To also install the optional Hugging Face / Transformers backend:
117+
118+ .. code :: bash
119+
120+ pip install -e " .[transformers]"
121+
115122 Editable mode enables testing of features/updates directly from the
116123source code and is an effective method for debugging.
117124
@@ -377,12 +384,6 @@ with a message similar to:
377384
378385 export OPENAI_API_KEY=" your_openai_api_key_here"
379386
380- And install the OpenAI library:
381-
382- .. code :: bash
383-
384- pip install openai
385-
386387 #. **Anthropic Models **: Codescribe supports Anthropic's Claude models
387388 (such as ``claude-opus-4-8 ``, ``claude-sonnet-4-6 ``,
388389 ``claude-haiku-4-5 ``, etc.) via the Anthropic API. The
@@ -398,12 +399,6 @@ with a message similar to:
398399
399400 export ANTHROPIC_API_KEY=" your_anthropic_api_key_here"
400401
401- And install the Anthropic library:
402-
403- .. code :: bash
404-
405- pip install anthropic
406-
407402 Optionally set ``ANTHROPIC_BASE_URL `` to redirect requests to a
408403 compatible proxy or private endpoint.
409404
@@ -460,11 +455,12 @@ with a message similar to:
460455 Face / Transformers checkpoint by passing its path as the model
461456 argument. Codescribe supports this through the ``TFModel `` backend.
462457
463- To use a Hugging Face model, first install the necessary libraries:
458+ To use a Hugging Face model, first install the optional
459+ ``transformers `` extra:
464460
465461 .. code :: bash
466462
467- pip install transformers torch
463+ pip install -e " .[transformers] "
468464
469465 Then specify the path to the pre-trained model using the ``-m `` flag.
470466 For example, to use a GPT-2 model:
0 commit comments