Skip to main content

Removes the boilierplate when working with shells in python.

Project description

QuickShell: Simplify Shell Command Execution in Python

PyPI - Version License: MIT Python 3.8+

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.2.0.tar.gz (2.5 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.2.0-py3-none-any.whl (3.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for quickshell-1.2.0.tar.gz
Algorithm Hash digest
SHA256 20ea5b30c7627571e1ec15452fd955c9f6f4714a04ca0aa7bcd50cc71cff4bb7
MD5 e1e3fa79500554c102f1840dc1151279
BLAKE2b-256 6ff63fb53eadde73f46dc799813ba632f2ce97830f883ef3c255dbf290a6aa8a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for quickshell-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e7163a1e67d6a359beb4bf226f49a7cf4696a72e9344d5501870d6b87211cb73
MD5 77a681cacefabb8e4d628b57eb3052cf
BLAKE2b-256 478d161a79e00aa12a774e7af360eca4464c70db03bc29225ee2c3cbaf3e0ef1

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