Skip to main content

Enhance ArgumentParser with a TCP-based API for argument handling.

Project description

netargparse

A Python library that imbues the standard ArgumentParser with an API for the Python script.

This library is intended as a replacement for the ArgumentParser of the standard argparse library, providing an additional TCP based API for handling the arguments of the script.

A minimal example minimal.py with the ArgumentParser could be

from argparse import ArgumentParser

def add_one(args):
    new_number = args.x + 1
    print(new_number)
    return(new_number)

parser = ArgumentParser()
parser.add_argument("-x", type=int, required=True)
args = parser.parse_args()
add_one(args)

and running the script results in

$ python minimal.py -x 5
6

Replacing the ArgumentParser with the NetArgumentParser from this library:

from netargparse import NetArgumentParser

def add_one(args):
    new_number = args.x + 1
    print(new_number)
    return(new_number)

nap = NetArgumentParser()
nap.parser.add_argument("-x", type=int, required=True)
nap(add_one)

The script can now be run in two modes:

  • main - standalone, same behaviour as above
  • nap - enable the API

Main

All arguments must be passed from the CLI after the main argument.

$ python minimal.py main -x 5
6

Nap

nap makes the script listen on a port and wait for the arguments.

$ python minimal.py nap --port 7000 --http

It is then possible to run the main function of the script by sending an HTTP get request with url parameters as arguments.

For example visit http://localhost:7000/?-x=5 with a browser and receive the script's return as json.

{"response": 6, "exception": "", "finished": 1}

Installation

For a minimal installation, where only plain TCP messages are used for communication, run

pip install netargparse

No additional libraries will be installed. All libraries used are part of The Python Standard Library.

If HTTP requests are to be used, run

pip install netargparse[http]

This will also install flask.

Documentation

More documentation can be found in docs.

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

netargparse-0.1.4.tar.gz (9.6 kB view details)

Uploaded Source

Built Distribution

netargparse-0.1.4-py3-none-any.whl (10.3 kB view details)

Uploaded Python 3

File details

Details for the file netargparse-0.1.4.tar.gz.

File metadata

  • Download URL: netargparse-0.1.4.tar.gz
  • Upload date:
  • Size: 9.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.9.19 Linux/5.14.0-503.14.1.el9_5.x86_64

File hashes

Hashes for netargparse-0.1.4.tar.gz
Algorithm Hash digest
SHA256 e2cb99762f4f16bdb15b80c2cfb7c8d66c4cc1bb97936c38e29126c1405ecd06
MD5 03679610188192e8a8e53da077db92fe
BLAKE2b-256 ce17b8e36ab49e88b2961edb4bc00c5c5ca51186b29265c1d6a7558c67ee5fd8

See more details on using hashes here.

File details

Details for the file netargparse-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: netargparse-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 10.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.9.19 Linux/5.14.0-503.14.1.el9_5.x86_64

File hashes

Hashes for netargparse-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 97883ee7e1b29be2c86913984a7f133caff7c655e3398b3b5a10b0fbe6583e28
MD5 a29cf60a48cfc5b8d8894bcbfdda669b
BLAKE2b-256 b78ad5b8acd47e416f4d416db684b7a438cdf9ff04e73f7f3bff992f95272b6f

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page