Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reorganise python scripts in repository, and unify install script. #13

Closed
schmie opened this issue Jul 9, 2015 · 13 comments
Closed

Reorganise python scripts in repository, and unify install script. #13

schmie opened this issue Jul 9, 2015 · 13 comments

Comments

@schmie
Copy link
Contributor

schmie commented Jul 9, 2015

Reported by rupert on 7 Oct 2011 16:57 UTC
I propose to reorganise hemeTools as follows:

Tools/Python/
Tools/HemeTools/setup.py (install script)
Tools/HemeTools/HemeTools (current hemeTools directory)
Tools/HemeTools/scripts (executable scripts, e.g. CfgParser.py)

This will require updating a bunch of python import statements and tweaking the setup.py, but will be more sane.

I would like to suggest renaming the executables with a prefix to make them all appear on tab-complete at the command line. I suggest "hlb" so we'd have hlb-cfgparser, hlb-countsites, etc

In the not-to-distant future, I will move the setuptool into this structure too.

Comments?

@schmie
Copy link
Contributor Author

schmie commented Jul 9, 2015

Comment by hywel on 8 Oct 2011 14:41 UTC
Yep, it might be nice to also have a bin directory to sym-links to all of the tools themselves to make it easy to add them all to your path at once. I also think lowerCamelCase is more consistent: hlbCfgParser, hlbCountSites etc.

Otherwise, I'm sold.

@schmie
Copy link
Contributor Author

schmie commented Jul 9, 2015

Comment by rupert on 11 Oct 2011 12:48 UTC
Regarding the bin directory, I think you have misunderstood slightly. The setup.py file is approximately the Python equivalent of a Makefile. It installs the hemetools module somewhere on your $PYTHONPATH, and will also install the executable scripts (the default location being the directory of the running python interpreter).

Agree about the camelcased script naming

I have also figured out how to enforce inter-package dependencies in python setup scripts so the setuptool does not have to move into this structure. I will delay a decision on that change for a while.

@schmie
Copy link
Contributor Author

schmie commented Jul 9, 2015

Comment by hywel on 11 Oct 2011 17:05 UTC
So long as I can just run 'setuptool' or whatever else from any directory, I don't mind where the Python libraries go so much. I assume you're making it easy to add all the executable scripts to my PATH in one go?

Cheers, sounds fine otherwise.

@schmie
Copy link
Contributor Author

schmie commented Jul 9, 2015

Modified by hywel on 13 Oct 2011 11:39 UTC

@schmie schmie added this to the 0.2 milestone Jul 9, 2015
@schmie
Copy link
Contributor Author

schmie commented Jul 9, 2015

Modified by rupert on 13 Oct 2011 15:23 UTC

@schmie schmie added the python Python helper tools and library label Jul 9, 2015
@schmie
Copy link
Contributor Author

schmie commented Jul 9, 2015

Comment by jamespjh on 15 Dec 2011 12:45 UTC
James will come up with a plan for this. Rupert will actually do the move.

@schmie schmie assigned jamespjh and unassigned rupertnash Jul 9, 2015
@schmie
Copy link
Contributor Author

schmie commented Jul 9, 2015

Modified by rupert on 19 Jan 2012 11:49 UTC

@schmie schmie removed this from the 0.2 milestone Jul 9, 2015
@schmie
Copy link
Contributor Author

schmie commented Jul 9, 2015

Modified by hywel on 1 Mar 2012 17:49 UTC

@schmie
Copy link
Contributor Author

schmie commented Jul 9, 2015

Modified by jamespjh on 7 Mar 2012 19:33 UTC

@schmie schmie added this to the Unscheduled milestone Jul 9, 2015
@schmie schmie changed the title Reorganise hemeTools and move executable py scripts into Tools Reorganise python scripts in repository, and unify install script. Jul 9, 2015
@schmie
Copy link
Contributor Author

schmie commented Jul 9, 2015

Modified by hywel on 8 Mar 2012 14:09 UTC

@schmie schmie added C: Python/analysis and removed python Python helper tools and library labels Jul 9, 2015
@schmie
Copy link
Contributor Author

schmie commented Jul 9, 2015

Modified by jamespjh on 5 Jul 2012 13:49 UTC

@schmie
Copy link
Contributor Author

schmie commented Jul 9, 2015

Modified by jamespjh on 5 Jul 2012 15:36 UTC

@schmie schmie added P: minor and removed P: major labels Jul 9, 2015
@rupertnash
Copy link
Member

Not happening any time soon - also duplicate of #48

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants