Skip to main content

Conscript console scripts in your own Swiss Army Knife.

Project description

Conscript: console scripts in your own Swiss Army Knife.

PyPI Version License Supported Pythons CI

Conscript provides a console script you can use to conveniently expose all other console scripts in a virtual environment. In a traditional virtual environment this is of little use. In a zipapp, it gives you capabilities similar to BusyBox.

Use

To create a BusyBox, simply add conscript to your dependencies and set your application main entrypoint to the conscript console script.

Examples

Examples are probably the best way to demonstrate the utility of Conscript. Both Pex and Shiv are popular tools for creating zipapps with third party dependencies; so they lead to concise examples.

Pex

  1. Create the BusyBox PEX zipapp:
    $ pex cowsay fortune conscript --script conscript --output-file speak
    
  2. Examine the available embedded apps:
    $ ./speak -h
    usage: speak [-h] [PROGRAM]
    
    A speak busy box.
    
    positional arguments:
      PROGRAM     The program to execute.
    
                  The following programs are available:
                  + cowsay
                  + fortune
    
    optional arguments:
      -h, --help  Show this help message and exit.
    
  3. Run an embedded app:
    $ ./speak cowsay "Conscript is my Swiss Army Knife!"
      _________________________________
    | Conscript is my Swiss Army Knife! |
      =================================
                                     \
                                      \
                                        ^__^
                                        (oo)\_______
                                        (__)\       )\/\
                                            ||----w |
                                            ||     ||
    
  4. Or another one:
    $ ./speak fortune -h
    Usage: speak [OPTIONS] [fortune_file]
    
    Options:
      -h, --help     show this help message and exit
      -V, --version  Show version and exit.
    
    If fortune_file is omitted, fortune looks at the FORTUNE_FILE environment
    variable for the path.
    $ ./speak fortune /usr/share/fortune/science
    Nondeterminism means never having to say you are wrong.
    
  5. Target an embedded app via a symlink:
    $ ln -s speak cowsay
    $ ./cowsay Nifty.
      ______
    | Nifty. |
      ======
          \
           \
             ^__^
             (oo)\_______
             (__)\       )\/\
                 ||----w |
                 ||     ||
    

Shiv

The capabilities exposed by Conscript are the same as in the Pex example, so this example is abbreviated to the basics. The primary difference is that Shiv does not fully isolate requested dependencies in the zipapp from incidental dependencies and so we see more available console scripts than in the Pex case.

  1. Create the BusyBox shiv zipapp:
    $ shiv cowsay fortune conscript --python '/usr/bin/env python' --console-script conscript --output-file say
    Collecting cowsay
      Using cached cowsay-4.0-py2.py3-none-any.whl (24 kB)
    Collecting fortune
      Using cached fortune-1.1.0-py2.py3-none-any.whl (5.9 kB)
    Collecting conscript
      Using cached conscript-0.1.1-py2.py3-none-any.whl (7.5 kB)
    Collecting grizzled-python>=1.0
      Using cached grizzled_python-2.2.0-py2.py3-none-any.whl (36 kB)
    Installing collected packages: grizzled-python, fortune, cowsay, conscript
    Successfully installed conscript-0.1.1 cowsay-4.0 fortune-1.1.0 grizzled-python-2.2.0
    
  2. Use it:
    $ ./say -h
    usage: say [-h] [PROGRAM]
    
    A say busy box.
    
    positional arguments:
      PROGRAM     The program to execute.
    
                  The following programs are available:
                  + cowsay
                  + easy_install
                  + easy_install-3.8
                  + fortune
                  + pip
                  + pip3
                  + pip3.8
                  + shiv
                  + shiv-info
    
    optional arguments:
      -h, --help  Show this help message and exit.
    $ ./say cowsay --version
    4.0
    

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

conscript-0.1.2.tar.gz (12.6 kB view details)

Uploaded Source

Built Distribution

conscript-0.1.2-py2.py3-none-any.whl (8.8 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file conscript-0.1.2.tar.gz.

File metadata

  • Download URL: conscript-0.1.2.tar.gz
  • Upload date:
  • Size: 12.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.25.1

File hashes

Hashes for conscript-0.1.2.tar.gz
Algorithm Hash digest
SHA256 494b4448e2d658b9e507379cc427c940f284ca64d92266f3b15f4815ca7b5afb
MD5 fd679ad1350248a6dc47d628c817d1f9
BLAKE2b-256 7755b7d408cd8e5b706dcccfc9388ac6952de2e8b60e8aff7ad60ee337e9d109

See more details on using hashes here.

File details

Details for the file conscript-0.1.2-py2.py3-none-any.whl.

File metadata

  • Download URL: conscript-0.1.2-py2.py3-none-any.whl
  • Upload date:
  • Size: 8.8 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.25.1

File hashes

Hashes for conscript-0.1.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 2c4b09a556ee28a7e9b403ff96bc12fd2d9e5458317699e41dad84752e65ba38
MD5 55ddb24f81c5773313e0eb32751a761c
BLAKE2b-256 a383423ff07efe8d8c0839f9ef037b85bafedc147094d75b31f17872126289d9

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