Skip to content

Update README.md #163

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
joelaguero merged 1 commit into from
Jan 28, 2025
Merged

Update README.md #163

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 9 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,21 @@

<p align="center">
<a href="https://docs.codegen.com">
<img src="https://github.com/user-attachments/assets/3ab806b5-c3bb-42f8-ac82-177cfd7e1732" />
<img src="https://github.com/user-attachments/assets/fdb2cd83-9967-41c2-a93d-cddff267ac79" />
</a>
</p>

<h2 align="center">
The Pythonic interface to transform your code.
Scriptable interface to a powerful, multi-lingual language server.
</h2>

<div align="center">

[![PyPI](https://img.shields.io/pypi/v/codegen?style=flat-square&color=blue)](https://pypi.org/project/codegen/)
[![Documentation](https://img.shields.io/badge/docs-docs.codegen.com-purple?style=flat-square)](https://docs.codegen.com)
[![Slack Community](https://img.shields.io/badge/slack-community-4A154B?logo=slack&style=flat-square)](https://community.codegen.com)
[![Follow on X](https://img.shields.io/twitter/follow/codegen?style=social)](https://x.com/codegen)
[![License](https://img.shields.io/badge/Code%20License-Apache%202.0-gray?&color=gray)](https://github.com/codegen-sh/codegen-sdk/tree/develop?tab=Apache-2.0-1-ov-file)
[![Follow on X](https://img.shields.io/twitter/follow/codegen?style=social)](https://x.com/codegen)

</div>

Expand All @@ -41,7 +42,8 @@ for function in codebase.functions:
Write code that transforms code. Codegen combines the parsing power of [Tree-sitter](https://tree-sitter.github.io/tree-sitter/) with the graph algorithms of [rustworkx](https://github.com/Qiskit/rustworkx) to enable scriptable, multi-language code manipulation at scale.

## Installation and Usage
**This library requires Python 3.12 – 3.13.**
This library requires **Python 3.12 – 3.13**. Currently, Codegen only supports macOS.

```
# Install inside existing project
uv pip install codegen
Expand All @@ -54,7 +56,7 @@ cd path/to/repo
codegen init
codegen create test-function

# Run said codemod
# Run the codemod
codegen run test-function

# Create an isolated venv with codegen => open jupyter
Expand All @@ -63,20 +65,18 @@ codegen notebook

## Usage

See [https://docs.codegen.com/introduction/getting-started] for a full tutorial.
See [Getting Started](https://docs.codegen.com/introduction/getting-started) for a full tutorial.

```
from codegen import Codebase

```

## Resources

- [Docs](https://docs.codegen.com)
- [Get Started](https://docs.codegen.com/introduction/getting-started)
- [Getting Started](https://docs.codegen.com/introduction/getting-started)
- [Contributing](CONTRIBUTING.md)


## Why Codegen?

Software development is fundamentally programmatic. Refactoring a codebase, enforcing patterns, or analyzing control flow - these are all operations that can (and should) be expressed as programs themselves.
Expand Down