v0.14; inline code commands are now robust, default working directory is now the main document directory instead of the output directory

Author: gpoore

NEWS.rst

@@ -7,6 +7,37 @@ Version History
 ===============
 
 
+v0.14 (2014/07/17)
+------------------
+
+New features
+~~~~~~~~~~~~
+
+*  All commands for working with code inline are now robust, via 
+   ``etoolbox``'s ``\newrobustcmd``.  Among other things, this allows 
+   commands like ``\py`` to work in standard captions that have not been 
+   redefined to avoid protection issues.
+*  Upgraded ``syncpdb`` to v0.2, which provides better list formatting.
+
+Backward-incompatible changes
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+*  The default working directory is now the main document directory instead 
+   of the output directory.  Using the output directory was a common source 
+   of confusion for new users and was incompatible with plans for future 
+   development.  Old documents in which the working directory was not 
+   specified will continue to use the output directory, but PythonTeX will 
+   print an upgrade message; new documents will use the new setting.  The 
+   output directory may be selected as the working directory manually, or 
+   with the shorthand 
+   "``\setpythontexworkingdir{<outputdir>}``".
+
+*  Standardized version numbering by removing the "v" prefix from the stored 
+   version numbers in Python variables and LaTeX macros.  Standardized the 
+   PythonTeX scripts by renaming ``version`` to ``__version__``.
+
+
+
 v0.13 (2014/07/14)
 ------------------
 

README.rst

@@ -41,79 +41,34 @@ Latest release
 
 (Full release history is available `here <https://github.com/gpoore/pythontex/blob/master/NEWS.rst>`_.)
 
-v0.13 (2014/07/14)
+v0.14 (2014/07/17)
 ------------------
 
 New features
 ~~~~~~~~~~~~
 
-*  Added ``--interactive`` command-line option. This runs a single
-   session in interactive mode, allowing user input. Among other things,
-   this is useful when working with debuggers.
-
-*  Added ``--debug`` command-line option. This runs a single session
-   with the default debugger in interactive mode. Currently, only
-   standard (non-console) Python sessions are supported. The default
-   Python debugger is the new ``syncpdb``, which wraps ``pdb`` and
-   synchronizes code line numbers with document line numbers. All
-   ``pdb`` commands that take a line number or filename:lineno as an
-   argument will refer to document files and line numbers when the
-   argument has a percent symbol (``%``) as a prefix. For example,
-   ``list %50`` lists code that came from around line 50 in the
-   document. The ``--debug`` option will support other languages and
-   provide for customization in the future.
-
-*  Added command-line option ``--jobs``, which allows the maximum number
-   of concurrent processes to be specified (#35).
-
-*  Added support for GNU Octave, via the ``octave`` family of commands
-   and environments (#36). Parsing of Octave stderr is not ideal, though
-   synchronization works in most cases; this will be addressed by a
-   future rewrite of the stderr parser.
-
-*  Installer now automatically works with MiKTeX, not just TeX Live.
-
-*  The PythonTeX utilities class has a new ``open()`` method that opens
-   files and automatically tracks dependencies/created files.
-
-*  When ``pythontex2.py`` and ``pythontex3.py`` are run directly, the
-   Python interpreter is automatically set to a reasonable default
-   (``py -2`` or ``py -3`` under Windows, using the Python 3.3+ wrapper;
-   ``python2`` or ``python3`` under other systems).
-
-*  The installer now creates symlinks for the numbered scripts
-   ``pythontex*.py`` and ``depythontex*.py``.
-
-*  Added Python version checking to all numbered scripts.
-
-*  Under Python, the type of data passed via ``\setpythontexcontext`` may 
-   now be set using YAML-style tags (``!!str``, ``!!int``, ``!!float``). For 
-   example, ``{myint=!!int 123}``.
-
-*  The ``fancyvrb`` options ``firstline`` and ``lastline`` now work with
-   the ``pygments`` environment and ``\inputpygments`` command. This required 
-   some additional patching of ``fancyvrb``.
-
-*  The ``pytx@Verbatim`` and ``pytx@SaveVerbatim`` environments are now
-   used for typesetting verbatim code. These are copies of the
-   ``fancyvrb`` environments. This prevents conflicts when literal
-   ``Verbatim`` and ``SaveVerbatim`` environments need to be typeset.
-
-*  Improved ``latexmk`` compatibility (#40). Added discussion of
-   ``latexmk`` usage to documentation.
-
-*  Tildes ``~`` may now be used in ``outputdir`` and ``workingdir`` to
-   refer to the user’s home directory, even under Windows.
-
-Bugfixes
-~~~~~~~~
-
-*  Fixed a bug that prevented created files from being cleaned up when
-   the working directory was not the document root directory and the
-   full path to the files was not provided.
-
-*  Fixed a bug that prevented the ``fvextfile`` option from working when
-   external files were highlighted.
+*  All commands for working with code inline are now robust, via 
+   ``etoolbox``'s ``\newrobustcmd``.  Among other things, this allows 
+   commands like ``\py`` to work in standard captions that have not been 
+   redefined to avoid protection issues.
+*  Upgraded ``syncpdb`` to v0.2, which provides better list formatting.
+
+Backward-incompatible changes
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+*  The default working directory is now the main document directory instead 
+   of the output directory.  Using the output directory was a common source 
+   of confusion for new users and was incompatible with plans for future 
+   development.  Old documents in which the working directory was not 
+   specified will continue to use the output directory, but PythonTeX will 
+   print an upgrade message; new documents will use the new setting.  The 
+   output directory may be selected as the working directory manually, or 
+   with the shorthand 
+   "``\setpythontexworkingdir{<outputdir>}``".
+
+*  Standardized version numbering by removing the "v" prefix from the stored 
+   version numbers in Python variables and LaTeX macros.  Standardized the 
+   PythonTeX scripts by renaming ``version`` to ``__version__``.
 
 
 Objectives for future releases

pythontex/depythontex2.py

@@ -86,7 +86,7 @@
 
 # Script parameters
 # Version
-version = 'v0.13'
+__version__ = '0.14'
 
 
 # Functions and parameters for customizing the script output
@@ -674,7 +674,7 @@ def replace_print_env(name, arglist, linenum,
 # Parse argv
 parser = argparse.ArgumentParser()
 parser.add_argument('--version', action='version', 
-                    version='DePythonTeX {0}'.format(version))
+                    version='DePythonTeX {0}'.format(__version__))
 parser.add_argument('--encoding', default='utf-8', 
                     help='encoding for all text files (see codecs module for encodings)')
 parser.add_argument('--overwrite', default=False, action='store_true',
@@ -726,7 +726,7 @@ def replace_print_env(name, arglist, linenum,
 
 # Let the user know things have started
 if args.output is not None:
-    print('This is DePythonTeX {0}'.format(version))
+    print('This is DePythonTeX {0}'.format(__version__))
     sys.stdout.flush()
 
 
@@ -792,7 +792,7 @@ def replace_print_env(name, arglist, linenum,
     depytx[n] = ''
     n -= 1
 # Check .depytx version to make sure it is compatible
-if settings['version'] != version:
+if settings['version'] != __version__:
     print('* DePythonTeX warning:')
     print('    Version mismatch with DePythonTeX auxiliary file')
     print('    Do a complete compile cycle to update the auxiliary file')

pythontex/depythontex3.py

@@ -86,7 +86,7 @@
 
 # Script parameters
 # Version
-version = 'v0.13'
+__version__ = '0.14'
 
 
 # Functions and parameters for customizing the script output
@@ -674,7 +674,7 @@ def replace_print_env(name, arglist, linenum,
 # Parse argv
 parser = argparse.ArgumentParser()
 parser.add_argument('--version', action='version', 
-                    version='DePythonTeX {0}'.format(version))
+                    version='DePythonTeX {0}'.format(__version__))
 parser.add_argument('--encoding', default='utf-8', 
                     help='encoding for all text files (see codecs module for encodings)')
 parser.add_argument('--overwrite', default=False, action='store_true',
@@ -726,7 +726,7 @@ def replace_print_env(name, arglist, linenum,
 
 # Let the user know things have started
 if args.output is not None:
-    print('This is DePythonTeX {0}'.format(version))
+    print('This is DePythonTeX {0}'.format(__version__))
     sys.stdout.flush()
 
 
@@ -792,7 +792,7 @@ def replace_print_env(name, arglist, linenum,
     depytx[n] = ''
     n -= 1
 # Check .depytx version to make sure it is compatible
-if settings['version'] != version:
+if settings['version'] != __version__:
     print('* DePythonTeX warning:')
     print('    Version mismatch with DePythonTeX auxiliary file')
     print('    Do a complete compile cycle to update the auxiliary file')