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 notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file runscript-0.2.11.tar.gz.
File metadata
- Download URL: runscript-0.2.11.tar.gz
- Upload date:
- Size: 5.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.7.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4b6d554456d0056664ecdc58833e7b86a0a3fd3d211e4732d08c9118fd5a18ee |
|
| MD5 | 55aded9c9e6cd7b74b0089a661ce988e |
|
| BLAKE2b-256 | 1f1e87af25cb4119e25823de71fe2dec9d8b259f436b908480d784d81a6348dd |
