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 Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

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

github_shell-2.2.0-py3-none-any.whl (51.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: github_shell-2.2.0-py3-none-any.whl
  • Upload date:
  • Size: 51.3 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-2.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9e269af0bda001a16a6105dedcc3134b26d394ce46ae22c47d2f42127bb8c03a
MD5 ac349f034753148150600a3df042c9a8
BLAKE2b-256 e5cfd56c5f2f3a0a19aa49ddf80166e562ab04eb250f41181a75f656749e80b4

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