Skip to main content

A package to convert GitHub repositories to formatted text.

Project description

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.

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

codescribe-1.0.4.tar.gz (4.7 kB view details)

Uploaded Source

Built Distribution

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

codescribe-1.0.4-py3-none-any.whl (3.9 kB view details)

Uploaded Python 3

File details

Details for the file codescribe-1.0.4.tar.gz.

File metadata

  • Download URL: codescribe-1.0.4.tar.gz
  • Upload date:
  • Size: 4.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.15

File hashes

Hashes for codescribe-1.0.4.tar.gz
Algorithm Hash digest
SHA256 c115ee0799dba730b861f118ff47161817647d1c74a609f54455543bf82f338d
MD5 6b5f882b0d306cdfadc6986c6a9c6d68
BLAKE2b-256 610f101e884ed8910d3dc9fdbbba47389d4cf5e69ed2f5ad8d553973d0561e8e

See more details on using hashes here.

File details

Details for the file codescribe-1.0.4-py3-none-any.whl.

File metadata

  • Download URL: codescribe-1.0.4-py3-none-any.whl
  • Upload date:
  • Size: 3.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.15

File hashes

Hashes for codescribe-1.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 260ffde39643e7b61658e422868b41ca48e68646fe303626596a8ff279ec127a
MD5 9676a524c9ddfc6398dfc4f0bbf316b6
BLAKE2b-256 83cb2bc99901a4046c0a7e170e99946064eb3e16be22bf0da215f378197efbf5

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