https://github.com/aashishnandakumar/codescribe
A package to convert GitHub repositories to formatted text
https://github.com/aashishnandakumar/codescribe
github packages python3
Last synced: 2 months ago
JSON representation
A package to convert GitHub repositories to formatted text
- Host: GitHub
- URL: https://github.com/aashishnandakumar/codescribe
- Owner: AashishNandakumar
- Created: 2024-10-02T11:12:00.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-16T10:51:03.000Z (over 1 year ago)
- Last Synced: 2026-01-05T22:20:59.008Z (6 months ago)
- Topics: github, packages, python3
- Language: Python
- Homepage: https://pypi.org/project/codescribe/
- Size: 68.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# CodeScribe
CodeScribe is a Python Package that allows you to convert GitHub repositories into formatted text, including a directory structure and file contents.
## Installation
You can install the package using pip:
```
pip install codescribe
```
## Usage
Here's a simple example of how to use the package:
```python
from codescribe import codescribe
repo_url = 'https://github.com/username/repo'
access_token = 'your_github_access_token' # optional
formatted_text = codescribe(repo_url, access_token)
print(formatted_text)
```
## Features
- Fetches repository contents from GitHub
- Generated a directory structure
- Formats file contents with proper seperation
- Supports private respositories with access token
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
## License
This project is licensed under the MIT License.