Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
30 changes: 13 additions & 17 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -97,21 +97,28 @@ modify existing files seamlessly.
Installation
**************

At present, we recommend installing Codescribe in a virtual
environment:
Codescribe uses ``pyproject.toml`` to declare its build system and
dependencies. We recommend installing in a virtual environment:

.. code:: bash

python3 -m venv env
source env/bin/activate
pip install --upgrade pip

And install Codescribe using ``pip`` in editable mode:
Install Codescribe and its core dependencies using ``pip`` in editable
mode:

.. code:: bash

pip install -e .

To also install the optional Hugging Face / Transformers backend:

.. code:: bash

pip install -e ".[transformers]"

Editable mode enables testing of features/updates directly from the
source code and is an effective method for debugging.

Expand Down Expand Up @@ -377,12 +384,6 @@ with a message similar to:

export OPENAI_API_KEY="your_openai_api_key_here"

And install the OpenAI library:

.. code:: bash

pip install openai

#. **Anthropic Models**: Codescribe supports Anthropic's Claude models
(such as ``claude-opus-4-8``, ``claude-sonnet-4-6``,
``claude-haiku-4-5``, etc.) via the Anthropic API. The
Expand All @@ -398,12 +399,6 @@ with a message similar to:

export ANTHROPIC_API_KEY="your_anthropic_api_key_here"

And install the Anthropic library:

.. code:: bash

pip install anthropic

Optionally set ``ANTHROPIC_BASE_URL`` to redirect requests to a
compatible proxy or private endpoint.

Expand Down Expand Up @@ -460,11 +455,12 @@ with a message similar to:
Face / Transformers checkpoint by passing its path as the model
argument. Codescribe supports this through the ``TFModel`` backend.

To use a Hugging Face model, first install the necessary libraries:
To use a Hugging Face model, first install the optional
``transformers`` extra:

.. code:: bash

pip install transformers torch
pip install -e ".[transformers]"

Then specify the path to the pre-trained model using the ``-m`` flag.
For example, to use a GPT-2 model:
Expand Down
File renamed without changes.
33 changes: 33 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
[build-system]
requires = ["setuptools>=61", "wheel"]
build-backend = "setuptools.build_meta"

[project]
name = "Codescribe"
version = "2026.dev"
authors = [{ name = "Codescribe Contributors" }]
description = "Coding Agent and Translation Utility"
license = { text = "Apache 2.0" }
readme = "README.rst"
classifiers = [
"Programming Language :: Python :: 3.8",
"License :: OSI Approved :: Apache Software License",
]
dependencies = [
"click",
"requests",
"toml",
"pyyaml",
"alive-progress==3.1.4",
"openai",
"anthropic",
]

[project.optional-dependencies]
transformers = ["torch", "transformers"]

[project.scripts]
code-scribe = "codescribe.cli:code_scribe"

[tool.setuptools.packages.find]
where = ["."]
7 changes: 0 additions & 7 deletions requirements/core.txt

This file was deleted.

2 changes: 0 additions & 2 deletions requirements/transformers.txt

This file was deleted.

43 changes: 0 additions & 43 deletions setup

This file was deleted.

54 changes: 0 additions & 54 deletions setup.py

This file was deleted.