Skip to main content

Removes the boilierplate when working with shells in python.

Project description

PyPI - Version License: MIT Python 3.7+

QuickShell: Simplify Shell Command Execution in Python

Overview

QuickShell is a simple Python library designed to remove the boilerplate when dealing with shell commands.

Key Features

  • Asynchronous Execution: Run shell commands asynchronously using asyncio.
  • Flexible Output Handling: Easily print and capture command output and errors.

Installation

Get started with QuickShell by installing it via pip:

pip install quickshell

Usage

use QuickShell to quickly run a command:

import asyncio
from quickshell import run_shell

async def main():
    cmd = 'echo Hello from the shell!'
    stdout, stderr = await run_shell(cmd, print_output=True) # Output: Hello from the shell!
    
if __name__ == '__main__':
    asyncio.run(main())

Explanation

  • Importing the Library: the run_shell function is imported from the quickshell library.
  • Define the Command: Replace "dir" with the shell command you want to execute.
  • Running the Command: The run_shell function executes the command asynchronously and captures its output.
  • Printing the Output: Set print_output=True to print the live output and errors from the shell.

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

quickshell-1.0.0.tar.gz (5.0 kB view details)

Uploaded Source

Built Distribution

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

quickshell-1.0.0-py3-none-any.whl (2.4 kB view details)

Uploaded Python 3

File details

Details for the file quickshell-1.0.0.tar.gz.

File metadata

  • Download URL: quickshell-1.0.0.tar.gz
  • Upload date:
  • Size: 5.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.11

File hashes

Hashes for quickshell-1.0.0.tar.gz
Algorithm Hash digest
SHA256 f49bf9a2fa6ad2bcd1265ef2e30b05944244715c11cd61240c9e7981fc030ed4
MD5 ebc1010866985dfbc03a909ef6318919
BLAKE2b-256 90d7f8f780cae3f90df924ecdb6ebea884db24efb4c10f061092c041bd0c6d47

See more details on using hashes here.

File details

Details for the file quickshell-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for quickshell-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 08a59ccd329629bbd43279ce0058e2256c4739378d2adcde444b992e50468d87
MD5 b2a8f744db10b4a4ec930053bf20f2bb
BLAKE2b-256 2906e18dc946ca0e8f14c97ba525647ee383302d8bdfb84b4db34b273e36184d

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