Skip to main content

A library for executing CEDARScript, a SQL-like language for code analysis and transformations

Project description

CEDARScript Editor (Python)

PyPI version Python Versions Code style: black License: MIT

CEDARScript Editor (Python) is a CEDARScript runtime for interpreting CEDARScript scripts and performing code analysis and modification operations on a codebase.

CEDARScript enables offloading low-level code syntax and structure concerns, such as indentation and line counting, from the LLMs. The CEDARScript runtime bears the brunt of file editing by locating the exact line numbers and characters to change, which indentation levels to apply to each line and so on, allowing the CEDARScript commands to focus instead on higher levels of abstraction, like identifier names, line markers, relative indentations and positions (AFTER, BEFORE, INSIDE a function, its BODY, at the TOP or BOTTOM of it...).

It acts as an intermediary between the LLM and the codebase, handling the low-level details of code manipulation and allowing the AI to focus on higher-level tasks.

What is CEDARScript?

CEDARScript (Concise Examination, Development, And Refactoring Script) is a domain-specific language that aims to improve how AI coding assistants interact with codebases and communicate their code modification intentions.

It provides a standardized way to express complex code modification and analysis operations, making it easier for AI-assisted development tools to understand and execute these tasks.

Features

  • Given a CEDARScript script and a base directory, executes the script commands on files inside the base directory;
  • Return results in XML format for easier parsing and processing by LLM systems

Installation

You can install CEDARScript Editor using pip:

pip install cedarscript-editor

Usage

Here's a quick example of how to use CEDARScript Editor:

from cedarscript_editor import CEDARScriptEdior

parser = CEDARScriptEdior()
code = """
CREATE FILE "example.py"
UPDATE FILE "example.py"
    INSERT AT END OF FILE
        CONTENT
            print("Hello, World!")
        END CONTENT
END UPDATE
"""

commands, errors = parser.parse_script(code)

if errors:
    for error in errors:
        print(f"Error: {error}")
else:
    for command in commands:
        print(f"Parsed command: {command}")

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License.

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

cedarscript_editor-1.1.5.tar.gz (43.3 kB view details)

Uploaded Source

Built Distribution

cedarscript_editor-1.1.5-py3-none-any.whl (30.3 kB view details)

Uploaded Python 3

File details

Details for the file cedarscript_editor-1.1.5.tar.gz.

File metadata

  • Download URL: cedarscript_editor-1.1.5.tar.gz
  • Upload date:
  • Size: 43.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for cedarscript_editor-1.1.5.tar.gz
Algorithm Hash digest
SHA256 35c7d157ae9da458dde7c239a40a6ce39b4ad6485bb6b3917412ba62d6cdeb30
MD5 2e4f16876d2be5d8e0a63a84b9a93ca7
BLAKE2b-256 f5a699f5296bf12c7d1d6803797ee23b2ec131df1d409e6c46294c934c49fb1f

See more details on using hashes here.

File details

Details for the file cedarscript_editor-1.1.5-py3-none-any.whl.

File metadata

File hashes

Hashes for cedarscript_editor-1.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 66d9231f7e4b22aba331ecd954958fffadeec174c542f2c2d39e7da32dd810e3
MD5 b114959a9724b60603c152350375d5e0
BLAKE2b-256 2f776d02738f17f6b2efeefa0eea5df1c637af4c75586720389c65ce8258d904

See more details on using hashes here.

Supported by

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