Skip to main content

Crimson GitHub App

A Python package to easily download contents from GitHub repositories.

Installation

pip install crimson-github-app

Main Function

The package exposes one main function for downloading repository contents:

from crimson.github_app import download_repo_contents

# Download repository contents
download_repo_contents(
    repo_name="username/repository",
    dir_in_repo="path/to/directory",
    output_dir="output",
    git_token=None
)

Parameters

  • repo_name (str): Full repository name in the format "username/repository"
  • dir_in_repo (str): Directory path within the repository to download from
  • output_dir (str, optional): Local directory to save files to. Defaults to "output"
  • git_token (str, optional): GitHub token for private repositories. Required for private repos

Example

# Download public repository contents
download_repo_contents(
    "crimson206/my-project",
    "src/examples",
    output_dir="downloaded_files"
)

# Download private repository contents
download_repo_contents(
    "crimson206/private-repo",
    "docs",
    output_dir="local_docs",
    git_token="your_github_token"
)

Requirements

  • Python ≥ 3.9
  • PyGithub

License

MIT License

Metadata

Release files for crimson-github-app 0.1.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for crimson-github-app 0.1.2
File Size Uploaded Provenance Actions
crimson_github_app-0.1.2.tar.gz 5.1 kB Without provenance Details for crimson_github_app-0.1.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for crimson-github-app 0.1.2
File Interpreter ABI Platform Actions
crimson_github_app-0.1.2-py3-none-any.whl Python 3 none any Details for crimson_github_app-0.1.2-py3-none-any.whl

Total release size: 10.7 kB

Release files / crimson_github_app-0.1.2.tar.gz

Download URL crimson_github_app-0.1.2.tar.gz
Size 5.1 kB
Tags Source
SHA-256 checksum
How to use checksums
b10c34d02d878ccf819c990c13c782924ed0ea9251f3324bf625f54f2fd3080f
BLAKE2b-256 checksum
How to use checksums
8d48edd8a62f95abcb0014c7ff93801002a8198c5acd1b16bfd51a8fbb230586
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.9.21

Release files / crimson_github_app-0.1.2-py3-none-any.whl

Download URL crimson_github_app-0.1.2-py3-none-any.whl
Size 5.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
5a418b199517f2fd25328b317009a6761c7ccd925475b71c92b435acdb16f0ea
BLAKE2b-256 checksum
How to use checksums
6614aa7b2cff87c53e5d87029694f64f19ada7b7b123e14bdb441b3788bc0bc5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.9.21

Security for crimson-github-app 0.1.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page