Polish the various utility scripts

Use argparse for more friendly argument parsing.

Also, add a `sagetex-tool` script that can be installed on PATH (unlike
makestatic.py etc. whose names are not suitable for that). Bundle the
script files in the sagetex python package. Do it in a way they remain
runnable standalone, as previously.

Author: pv

.gitignore

@@ -29,6 +29,12 @@ sagetex.py
 sagetex.pyc
 sagetex.sty
 sagetexparse.py
+__init__.py
+__main__.py
+run_if_necessary.py
+sagetex-tool
+sagetex/*.py
+__pycache__
 .*.sage-history
 .*.sage-chat
 MANIFEST

Makefile

@@ -2,10 +2,13 @@ pkg=sagetex
 dtxs=$(wildcard *.dtx)
 # the subdir stuff makes the tarball have the directory correct
 srcs=example.tex README sagetex.ins
+pyscripts=run-sagetex-if-necessary.py sagetex-tool
+pypkgfiles=__init__.py __main__.py sagetex.py makestatic.py extractsagecode.py sagetexparse.py run_if_necessary.py
+pypkg=$(addprefix sagetex/,$(pypkgfiles))
 
 .SUFFIXES:
 
-all: sagetex.sty sagetex.py example.pdf $(pkg).pdf
+all: sagetex.sty $(pypkg) $(pyscripts) remote-sagetex.py $(pkg).pdf example.pdf
 
 # just depend on the .ind file, since we'll make the .gls and .ind together;
 # TEXOPTS is used by spkg-install to specify nonstopmode when building docs
@@ -32,17 +35,20 @@ example.pdf: example.tex sagetex.sty sagetex.py
 sagetex.sty: py-and-sty.dtx $(pkg).dtx
 	yes | latex $(TEXOPTS) $(pkg).ins
 
-sagetex.py: py-and-sty.dtx $(pkg).dtx
-	yes | latex $(TEXOPTS) $(pkg).ins
-
 remote-sagetex.py: remote-sagetex.dtx
 	yes | latex $(TEXOPTS) $(pkg).ins
 
-run-sagetex-if-necessary.py makestatic.py extractsagecode.py sagetexparse.py: scripts.dtx
+$(pypkgfiles) $(pyscripts): py-and-sty.dtx scripts.dtx
 	yes | latex $(TEXOPTS) $(pkg).ins
+	mv -f sagetex-tool.py sagetex-tool
+	chmod +x sagetex-tool
+
+$(pypkg): $(pypkgfiles)
+	install -d sagetex
+	cp -f $(notdir $@) sagetex/
 
 clean: auxclean
-	rm -fr sage-plots-for-* E2.sobj *.pyc sagetex.tar.gz sagetex.py sagetex.pyc sagetex.sty makestatic.py sagetexparse.py extractsagecode.py dist MANIFEST remote-sagetex.py auto *_doctest.sage *_doctest.sage.py example-*.table run-sagetex-if-necessary.py __pycache__
+	rm -fr sage-plots-for-* E2.sobj *.pyc sagetex.tar.gz $(pypkg) $(pypkgfiles) $(pyscripts) sagetex.sty dist MANIFEST remote-sagetex.py auto *_doctest.sage *_doctest.sage.py example-*.table __pycache__ sagetex/
 
 auxclean:
 	/bin/bash -c "rm -f {$(pkg),example}.{glo,gls,aux,out,toc,dvi,pdf,ps,log,ilg,ind,idx,fdb_latexmk,sagetex.*}"
@@ -54,5 +60,5 @@ test:
 	./test
 
 # make a source distribution, used for building the spkg
-dist: sagetex.sty
+dist: sagetex.sty $(pypkg) $(pyscripts)
 	python setup.py sdist --formats=gztar

py-and-sty.dtx

@@ -145,7 +145,12 @@
 # -*- encoding: utf-8 -*-^^J%
 # This file (\jobname.sagetex.sage) was *autogenerated* from \jobname.tex with
 sagetex.sty version \ST@ver.^^J%
-import sagetex^^J%
+%    \end{macrocode}
+%   We here allow installing |sagetex.py| either as a single Python module,
+%   or as |sagetex.sagetex| inside a Python package.
+%    \begin{macrocode}
+try: import sagetex.sagetex as sagetex^^J%
+except ImportError: import sagetex^^J%
 _st_ = sagetex.SageTeXProcessor('\jobname', version='\ST@ver', version_check=\ST@versioncheck)}}%
 %    \end{macrocode}
 % On the other hand, if the |ST@final| flag is set, don't bother with
@@ -828,7 +833,7 @@ again}}
 %    \end{macrocode}
 %
 %
-% \subsection{The Python module}
+% \subsection{The Python package}
 % \label{sec:py-file}
 %
 % \iffalse
@@ -1570,9 +1575,22 @@ SAGE_ROOT/local/share/doc/sagetex.""")
 % % \changes{v2.1.1}{2009/05/14}{Fix bug in finding md5 sum introduced by
 % pause facility}
 % \end{macro}
+% \iffalse
+%</python>
+% \fi
+
+% \paragraph{Package \_\_init\_\_.py}
+%
+% We'll also create an empty |__init__.py| for including the above in a
+% Python package, containing also the scripts.
+%
+% \iffalse
+%<*initpy>
+%</initpy>
+% \fi
 
 % \endinput
-%</python>
+
 % Local Variables:
 % mode: doctex
 % TeX-master: "sagetex.dtx"

sagetex.ins

@@ -82,6 +82,7 @@ with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 \generate{\file{sagetex.py}{\from{sagetex.dtx}{python}
                             \from{py-and-sty.dtx}{python}}}
+\generate{\file{__init__.py}{\from{py-and-sty.dtx}{initpy}}}
 \generate{\file{sagetexparse.py}{\from{scripts.dtx}{parsermod}}}
 
 
@@ -92,19 +93,22 @@ with this program.  If not, see <http://www.gnu.org/licenses/>.
 \def\envpypreamble{\hash!/usr/bin/env python^^J\pypreamble}
 \usepreamble\envpypreamble
 
+\generate{\file{sagetex-tool.py}{\from{scripts.dtx}{sagetextool}}}
+\generate{\file{__main__.py}{\from{scripts.dtx}{mainpy}}}
 \generate{\file{run-sagetex-if-necessary.py}{\from{scripts.dtx}{ifnecessaryscript}}}
+\generate{\file{run_if_necessary.py}{\from{scripts.dtx}{ifnecessaryscript}}}
 \generate{\file{makestatic.py}{\from{scripts.dtx}{staticscript}}}
 \generate{\file{extractsagecode.py}{\from{scripts.dtx}{extractscript}}}
 \generate{\file{remote-sagetex.py}{\from{remote-sagetex.dtx}{remotesagetex}}}
 
 \obeyspaces
 \Msg{******************************************************************}
 \Msg{*                                                                *}
-\Msg{* To finish the installation, move the following files           *}
+\Msg{* To finish the installation, move the following file/package    *}
 \Msg{* into directories searched by TeX and Sage, respectively:       *}
 \Msg{*                                                                *}
 \Msg{*     sagetex.sty                                                *}
-\Msg{*     sagetex.py                                                 *}
+\Msg{*     sagetex/                                                   *}
 \Msg{*                                                                *}
 \Msg{* See the documentation for complete installation details.       *}
 \Msg{*                                                                *}