Skip to main content

Simple tool to parse shell arguments using eval

Project description

ShellArgParser

A simple python tool to parse any arg / kwarg arguments in a manner that is easy to parse for the linux shell.

I don't understand

For example:

uvx ShellArgParser@latest a_file --test=something -a -b -no-c another_file

Will print this text:

ARGS_1="a_file"
ARGS_2="another_file"
ARGS_TEST="something"
ARGS_A=1
ARGS_B=1
ARGS_C=0

So running this:

eval $(uvx ShellArgParser@latest --test=something -a -b -no-c)

Will parse the args and kwargs as shell environment variables, handy for use in the shell:

echo $ARGS_TEST  # outputs 'something'

But why would you make this?

Handling user arguments are a major annoyance for me in shell, and in python using fire makes it a breeze, so it's is a great way to avoid reinventing the wheel. Hence, when writing a small shell script, using a python cli tool oneliner makes is a real time saver for me.

Notes:

  • -something is parsed as ARGS_SOMETHING=1
  • -no-something is parsed as ARGS_SOMETHING=0
  • -no_something is parsed as ARGS_SOMETHING=0
  • Any None python value is parsed as 0
  • A prototype 'pure shell' version of this script can be found in ./ShellArgParser.sh

Getting started

  • From pypi:
    • As a uv tool: uvx ShellArgParser@latest --help
    • Via uv: uv pip install ShellArgParser
    • Via pip: pip install ShellArgParser
  • From github:
    • Clone this repo then pip install .

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

shellargparser-0.2.4.tar.gz (14.9 kB view details)

Uploaded Source

Built Distribution

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

shellargparser-0.2.4-py3-none-any.whl (15.5 kB view details)

Uploaded Python 3

File details

Details for the file shellargparser-0.2.4.tar.gz.

File metadata

  • Download URL: shellargparser-0.2.4.tar.gz
  • Upload date:
  • Size: 14.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.14

File hashes

Hashes for shellargparser-0.2.4.tar.gz
Algorithm Hash digest
SHA256 004ef111da6ab68f8ea133d7751571f1cc70109bbc8e7c3c4670b9ba880ddfa3
MD5 251eddbdadb5bdeaa140c6fb93a6b385
BLAKE2b-256 2e508a591cef17ebd1e41553a58c18284730b9f50c90324b53a8ef051688105d

See more details on using hashes here.

File details

Details for the file shellargparser-0.2.4-py3-none-any.whl.

File metadata

  • Download URL: shellargparser-0.2.4-py3-none-any.whl
  • Upload date:
  • Size: 15.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.14

File hashes

Hashes for shellargparser-0.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 8cc19bbeff0cb558a4a41f715155956f620de1e5815434a9c64f1cd80b17e37e
MD5 1fd0336260dbf0cbe47b5ed859868697
BLAKE2b-256 948b34158fab6dc158cc3b75be96bdc32d55276f1935ea4b58c2ec159f8a779f

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