discordshell 0.0.3
DShell is a package that combines with discord.py and Jishaku to turn a Discord channel into a shell on which bash commands can be run.
License: MIT
Requires Python: >=3.6.0
Keywords: shell,discord,terminal,powershell,command-prompt,internet,console,shell-access,utility

<p align="center"><img src="https://raw.githubusercontent.com/ImNimboss/dshell/main/.github/assets/readme/dshell-logo.png" alt="DShell Logo"></p>

# DShell

<a href="https://pypi.org/project/discordshell" target="_blank" rel="noopener noreferrer">
    <img src="https://img.shields.io/pypi/v/discordshell.svg?color=9cf&logo=pypi" alt="PyPI DShell version number">
    <img src="https://img.shields.io/pypi/dm/discordshell?color=9cf&logo=pypi" alt="PyPI downloads per month">
    <img src="https://img.shields.io/pypi/pyversions/discordshell.svg?color=9cf&logo=pypi" alt="PyPI supported Python versions">
</a>
<a href="https://github.com/ImNimboss/dshell/issues" target="_blank" rel="noopener noreferrer">
    <img src="https://img.shields.io/github/issues/ImNimboss/dshell?color=9cf&logo=github" alt="Number of open GitHub issues">
</a>
<a href="https://github.com/ImNimboss/dshell/contributors" target="_blank" rel="noopener noreferrer">
    <img src="https://img.shields.io/github/contributors/ImNimboss/dshell?color=9cf&logo=github" alt="Number of contributors">
</a>
<a href="https://discord.gg/FcxqdJ7AQq" target="_blank" rel="noopener noreferrer">
    <img src="https://img.shields.io/discord/930791886522810399?color=9cf&logo=discord&label=discord" alt="Discord server">
</a>

## Description

Discord shell or dshell for short is a Python package that combines with [discord.py](https://github.com/Rapptz/discord.py) and [Jishaku](https://github.com/Gorialis/jishaku) to transform an ordinary Discord channel into one capable of running bash commands using a Discord bot.

## Typical usage

<!--Ratio of height:width of image should be 87:84-->
<p align="center"><img src="https://github.com/ImNimboss/dshell/blob/main/.github/assets/readme/dshell-example.gif?raw=true" height="435" width="420"></p>

## When would I use this?

* When you want to use shell commands on your virtual private server (VPS) without logging into it
* When you want a collaborative terminal with other developers of your team
* When you're simply too lazy to open your shell and would rather do it in an open Discord app
* When you want to run shell commands from your Discord bot's directory easily
* When you want to run shell commands on something that simply looks better than your shell

## Main Features

- [x] - Customizable
- [x] - Easy to use
- [x] - Asynchronous
- [x] - Compatible with discord.py v2.0
- [x] - Lightweight
- [x] - Regularly maintained

## Links
* [Documentation](https://github.com/ImNimboss/dshell/tree/main/Documentation)
* [PyPI](https://pypi.org)
* [Issue Tracking](https://github.com/ImNimboss/dshell/issues)
* [Discord server](https://discord.gg/FcxqdJ7AQq)

## Installation and upgrades

```
pip install discordshell
```
for the stable version (recommended).

```
pip install -U discordshell
```
to update your stable version.

```
pip install git+https://github.com/ImNimboss/dshell
```
to install it straight off of GitHub (you need git installed for this).

```
pip install -U git+https://github.com/ImNimboss/dshell
```
to upgrade your version that you got from GitHub.

## How to use

Check [Documentation/Basics.md](https://github.com/ImNimboss/dshell/blob/main/Documentation/Basics.md)

## Examples

Check [Documentation/Examples.md](https://github.com/ImNimboss/dshell/blob/main/Documentation/Examples.md)