Skip to main content

Simplify writing dual use scripts for CLI and Snakemake

Project description

SnaCLI

SnaCLI is a library which simplifies writing scripts which can be both run directly from the command line (based on docopt), as well as be called in a Snakemake file.

Introduction

In the Snakemake workflow management system, tasks can call Python scripts and pass them input, output and log filenames as well as global configuration values and non-filename parameters.

The system for passing and accessing these arguments is different to that adopted by command line tools (for example using the docopt library).

SnaCLI allows to easily combine the two approaches (docopt and snakemake) for providing arguments to a script. Script based on SnaCLI can be invoked both from the command line and from snakemake. Inside the script, the same code can be used in both cases, without modifications.

Usage

The usage of the library is explained in the user manual.

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

snacli-1.2.tar.gz (12.2 kB view details)

Uploaded Source

Built Distribution

snacli-1.2-py3-none-any.whl (4.7 kB view details)

Uploaded Python 3

File details

Details for the file snacli-1.2.tar.gz.

File metadata

  • Download URL: snacli-1.2.tar.gz
  • Upload date:
  • Size: 12.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.5

File hashes

Hashes for snacli-1.2.tar.gz
Algorithm Hash digest
SHA256 b00d8e89cc0b4343869e86d9850fbf00536f9e247255bbb6da73fbb7261ef9e7
MD5 eac0d5f4e451899e594141549cb9fac7
BLAKE2b-256 76ada4665d6918e286c3d3fc87c0cba66f8a8ef99af253a48521e2f85cd8cfd7

See more details on using hashes here.

File details

Details for the file snacli-1.2-py3-none-any.whl.

File metadata

  • Download URL: snacli-1.2-py3-none-any.whl
  • Upload date:
  • Size: 4.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.5

File hashes

Hashes for snacli-1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 8e3d98a205fd9e18a36cbdd4d98a096ac32285af5447f1afde6fc5af502c85b7
MD5 2bf27e69d77b017ffe7f187620128c3b
BLAKE2b-256 fccc4fecc368542655233a8f8919d3bf07592ebea420e408dd6bda2f2ff8c35e

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