Skip to main content

A GitHub simulation shell with automatic update feature

Project description

GitHub Simulation Shell

A feature-rich GitHub simulation shell that provides a command-line interface for GitHub operations.

Features

Repository Operations

  • repos - List current user's repositories
  • repo <owner>/<repo> - View specified repository information
  • issues <repo> - View repository Issues
  • branches <repo> - View repository branches
  • commits <repo> - View recent repository commits
  • contributors <repo> - View repository contributors
  • prs <repo> - View repository Pull Requests
  • gists <username> - View user's Gists

Search Functionality

  • search <query> - Search GitHub repositories

Organization Operations

  • org <orgname> - View specified organization information

User Operations

  • user <username> - View specified user information
  • followers - View current user's followers
  • following - View current user's following

System Commands

  • help - Display help information
  • clear - Clear the screen
  • exit - Exit the simulation shell
  • update - Check and update to the latest version
  • version - Display current version

Installation

Install from PyPI

pip install github-shell

Install from Source

git clone https://github.com/wjr-2015/wjr-2015-github_shell.git
cd wjr-2015-github_shell
pip install -e .

Usage

Basic Usage

github-shell

Command Examples

# List current user's repositories
github-shell:wjr-2015$ repos

# View specified repository information
github-shell:wjr-2015$ repo octocat/Hello-World

# Search repositories
github-shell:wjr-2015$ search python github

# Check for updates
github-shell:wjr-2015$ update

Configuration

Set GitHub Token

To access private repositories, you can set your GitHub token in the script:

# Set in github_shell/config.py
TOKEN = "your_github_token"

Auto Update

The script includes an auto-update feature. Run the update command to check and update to the latest version.

Version History

  • v1.1.0 - Added contributors view, PR view, Gists view, repository search, organization information view, etc.
  • v1.0.0 - Initial version with basic repository and user operations

License

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

github_shell-1.2.0.tar.gz (37.5 kB view details)

Uploaded Source

Built Distribution

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

github_shell-1.2.0-py3-none-any.whl (48.8 kB view details)

Uploaded Python 3

File details

Details for the file github_shell-1.2.0.tar.gz.

File metadata

  • Download URL: github_shell-1.2.0.tar.gz
  • Upload date:
  • Size: 37.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for github_shell-1.2.0.tar.gz
Algorithm Hash digest
SHA256 08b4fcf670204811213e41537969792acf6c44be609bfd33a7d3395904eca71c
MD5 202f4dab39a052014f496cf89f451b80
BLAKE2b-256 46423d973123d7413d8fe48eafcff020c7e5421cbd8f43b6f21eb23c3aecd90f

See more details on using hashes here.

File details

Details for the file github_shell-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: github_shell-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 48.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for github_shell-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cfc64ff218d5b3e315bc33bf5242377dcec26f90b469ddad3e34e0ae190fb35f
MD5 9f5c9cd2939401e7ef0993ce8d92af37
BLAKE2b-256 8745a391008384dfa762c8a5807049d4afcf2576bd2571f931207ce92c276149

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