mdozmorov / genome_runner

Academic Free License v3.0
0 stars 3 forks source link

Prepare GR for release #91

Open mdozmorov opened 9 years ago

mdozmorov commented 9 years ago

We need to create a new repository 'genome_runner_web' for release. The current one has several Mb of unneeded stuff.

Remove "developer mode" of installation.

Tidy up command line arguments in the scripts, remove unnecessary ones.

Cory's advice: I would strongly suggest that users not have to directly do "python -m grsnp.hypergeom4 ....". You can wrap this in an executable script. Having a module named hypergeom4 is bad enough, but when you publish that API, you make it so that you cannot change it ever. It could be as simple as:

File name: genome-runner Content:

!/usr/bin/env bash

python -m grsnp.hypergeom4 "$@"

Alternatively, you can look into the "console_scripts" argument to setup.py, which can install any of your python functions as a script automatically when the package is installed. This comment also applies to other stages of the process, like "python -m grsnp.optimizer ...". Another way of doing it would be a master script, called genome-runner, which would take as a first argument the command to be performed. So it would be called like,

$ genome-runner optimize