This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

Simple script launcher

Project Description

It is not a rare case when the project has a few tasks to run periodically or at certain times e.g. deploying the project on the server or initial generation of data for new work place. Runscript package provides simple \(run\) utility that you can use to run your tasks. The \(run\) command is nothing more than launcher of the \(main()\) function of one of your scripts stored in predefined directory. Also \(run\) utility slightly simplifies the handling of command line arguments.

Real world example

Suppose you need to save some data from database into text file. For example, you have some web-site with user accounts and you want to dump the ID of each user account and also its email. Also you want to be able to choose the country of accounts to dump. Create “script/” directory in the root of your project and then create the file “script/dump.py” with content:

import pymongo

def setup_arg_parser(parser):
    parser.add_argument('-c', '--count')

def main(count, **kwargs):
    with open('export/user.csv', 'w') as out:
        for user in db.user.find({'country': country}):
            out.write('%s:%s\n' % (user['_id'], user['email']))

Few words about what is going here. The value of \(parser\) option that is passed to \(setup_arg_parser\) is the instance of \(ArgumentParser\) class. You can add any option you need or just do not specify \(setup_arg_parser\) in you script. If you define some custom options then their values will be passed in \(**kwargs\) arguments to your \(main\) function.

OK, now you can run the following command from the console:

$ run dump

That’s all :) Of course this is not the rocket science, but I found that this simple script launcher saved me a lot of time.

Release History

Release History

This version
History Node

0.2.6

History Node

0.2.5

History Node

0.2.3

History Node

0.2.2

History Node

0.2.1

History Node

0.2.0

History Node

0.1.1

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
runscript-0.2.6.tar.gz (4.8 kB) Copy SHA256 Checksum SHA256 Source Jan 21, 2017

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting