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:
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.
Metadata
Release files for codescribe 1.0.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| codescribe-1.0.4.tar.gz | 4.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| codescribe-1.0.4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 8.6 kB
Release files / codescribe-1.0.4.tar.gz
| Download URL | codescribe-1.0.4.tar.gz |
|---|---|
| Size | 4.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c115ee0799dba730b861f118ff47161817647d1c74a609f54455543bf82f338d
|
|
BLAKE2b-256 checksum How to use checksums |
610f101e884ed8910d3dc9fdbbba47389d4cf5e69ed2f5ad8d553973d0561e8e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.10.15
|
Release files / codescribe-1.0.4-py3-none-any.whl
| Download URL | codescribe-1.0.4-py3-none-any.whl |
|---|---|
| Size | 3.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
260ffde39643e7b61658e422868b41ca48e68646fe303626596a8ff279ec127a
|
|
BLAKE2b-256 checksum How to use checksums |
83cb2bc99901a4046c0a7e170e99946064eb3e16be22bf0da215f378197efbf5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.10.15
|