Tools and scripts directory
I (Reinout van Rees) use quite a number of shell scripts, small custom Python utilities, other Python programs and so on. In this project, I collect most of them.
The idea is that this directory's bin subdirectory is on my path.
- Shell scripts go in
./install_shell_scripts.shsymlinks these into the
setup.pylists dependencies, such as pep8, pyflakes and zest.releaser.
pip install .installs them all.
setup.pyalso has a couple of scripts of its own, in the
pip install .also installs those.
Useful to others? Yes, as examples and for copy-pasting of handy scripts
The code in here can be useful to others: ideas for shell scripts and small
Python utilities. The
svngrep shell script has found its way to several
colleague's computers, for instance.
So putting it on github seems like a good idea.
Bootstrap installation notes for myself
bin/pip install . -r requirements.txtto make sure I end up with the right versions.
- Do a git pull of
ssh://vanrees.org/~/git/Dotfilesinto my homedir and run
dotfiles --sync: this gives me my dotfiles, including the checkoutmanager configuration.
pip install -eon several checkouts of packages I develop myself, such as zest.releaser. So that I always run trunk to make sure everything works fine. Run this after everything is in place: we install checkoutmanager which we ourselves need as it does the checkouts we want to
pip install -e:-)
I'm trying to do this the neat way: I've even added explanatory comments to
all shell scripts. And I've got a
generate_shell_docs.py that generates a
README from those comments. Look in the shell directory (for instance on
github) and you'll see
the nicely formatted README at the bottom.
Likewise I've got a README for the python scripts. Look on github and you'll see the
nicely formatted README at the bottom. This is generated from the scripts'
generate_python_docs.py (I just want a simple README, not
full Sphinx documentation).