Skip to main content

AI-powered code explainer and semantic diff tool

Project description

Alethe

Alethe is an AI-powered code explainer and semantic diff tool. It generates human-readable markdown explanations for Python files and compares different versions to highlight semantic changes.

Features

  • Generate markdown explanations of Python code.
  • Track file versions and compute semantic diffs between explanations.
  • Works with local Hugging Face models or a stub mode for offline testing.
  • CLI interface for easy usage.

Installation

You can install Alethe from PyPI:

pip install alethe

Usage

Basic CLI usage:

alethe explain path/to/file.py
alethe summary path/to/file.py
alethe diff path/to/file.py v1 v2
alethe list path/to/file.py
alethe rename old_file.py new_file.py
alethe getpath <file_id>

Example

Generate an explanation for example.py:

alethe explain example.py

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

alethe-0.1.0.tar.gz (5.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

alethe-0.1.0-py2.py3-none-any.whl (7.0 kB view details)

Uploaded Python 2Python 3

File details

Details for the file alethe-0.1.0.tar.gz.

File metadata

  • Download URL: alethe-0.1.0.tar.gz
  • Upload date:
  • Size: 5.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.5

File hashes

Hashes for alethe-0.1.0.tar.gz
Algorithm Hash digest
SHA256 5b1c97635a55dbd2475474a5a0f0387824ab832d8835b6693575497db3932905
MD5 1a323baeef9392a48a84f69fdf5633dc
BLAKE2b-256 27e72ad354e827b967c3af402aa269365ae2456b82babb2541a501355c5f09ed

See more details on using hashes here.

File details

Details for the file alethe-0.1.0-py2.py3-none-any.whl.

File metadata

  • Download URL: alethe-0.1.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 7.0 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.5

File hashes

Hashes for alethe-0.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a56a458aca4595e151c7813536fbb626e4d649622183f7811a3f89aea1a442d8
MD5 d61fd21957a5c4065561eedc5150eb29
BLAKE2b-256 7c0d0b13be0e4ef892771b5aea51e7edea2dc83b1f26fbcf33ea4ebca6c7ae31

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page