Runscript package
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.
1 maintainer
Metadata
1 maintainer
Release files for runscript 0.3.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| runscript-0.3.5.tar.gz | 6.1 kB | Without provenance | Details |
Release files / runscript-0.3.5.tar.gz
| Download URL | runscript-0.3.5.tar.gz |
|---|---|
| Size | 6.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8b79c169a17b160181e496f8e4a66bb5323081d0ed43db7ec8785093ea067302
|
|
BLAKE2b-256 checksum How to use checksums |
e6819d298a1417bf04925b2066d5115032498b730e5f3b400be00cdfd310929e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.1
|
Security for runscript 0.3.5
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
