docs: General polish pass prior to release: put my e-mail in for Trevor's, updated HISTORY and AUTHORS, ticked the version number.

Author: rbeyer

AUTHORS.rst

@@ -2,17 +2,22 @@
 Credits
 =======
 
-Development Lead
-----------------
-
-* Trevor Olson <[email protected]>
+The pvl library was originally developed by Trevor Olson.
 
-Contributors
-------------
+Authors
+-------
 
+* Trevor Olson <[email protected]> (Original Author and former development lead)
 * Sarah Braden <[email protected]>
 * Michael Aye <[email protected]>
 * Austin Godber <[email protected]>
 * Perry Vargas <[email protected]>
 * `Benoit Seignovert <https://github.com/seignovert>`_
 * `Ross Beyer <https://github.com/rbeyer>`_
+
+
+Acknowledgements
+----------------
+
+Thanks to Michael Aye, Andrew Annex, and Chase Million for valuable discussions during the
+lead-up to the 1.0.0 release.

HISTORY.rst

@@ -3,6 +3,43 @@
 History
 -------
 
+1.0.0 (2020-08-23)
+~~~~~~~~~~~~~~~~~~
+This production version of the pvl library consists of significant
+API and functionality changes from the 0.x version that has been
+in use for 5 years (a credit to Trevor Olson's skills).  The
+documentation has been significantly upgraded, and various granular
+changes over the 10 alpha versions of 1.0.0 over the last 8 months
+are detailed below.  However, here is a high-level overview of what
+changed from the 0.x version:
+
+* Only guaranteed to work with Python 3.6 and above.
+* Rigorously implemented the three dialects of PVL text: PVL itself,
+  ODL, and the PDS3 Label Standard.  There is a fourth de-facto
+  dialect, that of ISIS cube labels that is also handled.  Please see
+  the "Standards & Specifications" section of the documentation.
+* There is now a default dialect for the dump functions: the PDS3 Label Standard.
+  This is different and more strict than before, but other output dialects are
+  possible.  Please see the "Writing out PVL text" section in the documentation
+  for more information, and how to enable an output similar to the 0.x output.
+* ``pvl.load()`` and ``pvl.dump()`` take all of the arguments that they could take
+  before (string containing a filename, byte streams), but now also accept any
+  ``os.PathLike`` object, or even an already-opened file object.
+* Utility programs `pvl_validate` and `pvl_translate` were added, please see
+  the "Utility Programs" section of the documentation for more information.
+* All ``datetime.time`` and ``datetime.datetime`` objects returned from the loaders
+  are now timezone "aware." Previously some were and some were not.
+* There are now ``pvl.collections`` and ``pvl.exceptions`` modules.  There was previously
+  an internal ``pvl._collections`` module, and the exception classes were scattered through
+  the other modules.
+* Quantities: The `pvl.collections.Units` object is pending deprecation in favor of
+  the new ``pvl.collections.Quantity`` object (really a name-only change, no functionality
+  difference).  The library can now parse and encode PVL Values with Units expressions
+  with third-party quantity objects like `astropy.units.Quantity` and `pint.Quantity`.
+  Please see the "Quantities: Values and Units" section of the documentation.
+
+
+
 1.0.0-alpha.9 (2020-08-18)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 * Minor addition to pvl.collections.MutableMappingSequence.

README.rst

@@ -62,7 +62,7 @@ Basic Usage
 ``pvl`` exposes an API familiar to users of the standard library
 ``json`` module.
 
-Decoding is primarily done through ``pvl.load()`` for file like objects and
+Decoding is primarily done through ``pvl.load()`` for file-like objects and
 ``pvl.loads()`` for strings::
 
     >>> import pvl
@@ -79,7 +79,10 @@ Decoding is primarily done through ``pvl.load()`` for file like objects and
     >>> print(module['foo'])
     bar
 
-You may also use ``pvl.load()`` to read PVL text directly from an image_::
+There is also a ``pvl.loadu()`` to which you can provide the URL of a file that you would normally provide to
+``pvl.load()``.
+
+You may also use ``pvl.load()`` to read PVL text directly from an image_ that begins with PVL text::
 
     >>> import pvl
     >>> label = pvl.load('tests/data/pattern.cub')
@@ -158,7 +161,16 @@ with ``dict``-style access::
     END
     <BLANKLINE>
 
-The intent is for the loaders (``pvl.load()`` and ``pvl.loads()``)
+However, there are some aspects to the default ``pvl.PVLModule`` that are not entirely
+aligned with the modern Python 3 expectations of a Mapping object.  If you would like
+to experiment with a more Python-3-ic object, you could instantiate a
+``pvl.collections.PVLMultiDict`` object, or ``import pvl.new as pvl`` in your code
+to have the loaders return objects of this type (and then easily switch back by just
+changing the import statement).  To learn more about how PVLMultiDict is different
+from the existing OrderedMultiDict that PVLModule is derived from, please read the
+new PVLMultiDict documentation.
+
+The intent is for the loaders (``pvl.load()``, ``pvl.loads()``, and ``pvl.loadu()``)
 to be permissive, and attempt to parse as wide a variety of PVL text as
 possible, including some kinds of 'broken' PVL text.
 

pvl/__init__.py

@@ -23,8 +23,8 @@
 )
 
 __author__ = "The pvl Developers"
-__email__ = "[email protected]"
-__version__ = "1.0.0-alpha.9"
+__email__ = "[email protected]"
+__version__ = "1.0.0"
 __all__ = [
     "load",
     "loads",

setup.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 1.0.0-alpha.9
+current_version = 1.0.0
 commit = False
 tag = False
 parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(\-(?P<prerelease>[a-z]+)\.((?P<serial>\d+)))?

setup.py

@@ -12,11 +12,11 @@
 
 setup(
     name='pvl',
-    version='1.0.0-alpha.9',
+    version='1.0.0',
     description='Python implementation of PVL (Parameter Value Language)',
     long_description=readme + '\n\n' + history,
     author='The PlanetaryPy Developers',
-    author_email='[email protected]',
+    author_email='[email protected]',
     url='https://github.com/planetarypy/pvl',
     packages=[
         'pvl',
@@ -28,13 +28,15 @@
     zip_safe=False,
     keywords='pvl',
     classifiers=[
-        'Development Status :: Development Status :: 3 - Alpha',
+        'Development Status :: 5 - Production/Stable',
         'Intended Audience :: Developers',
         'Intended Audience :: Science/Research',
         'License :: OSI Approved :: BSD License',
         'Natural Language :: English',
         'Programming Language :: Python :: 3.6',
         'Programming Language :: Python :: 3.7',
+        'Programming Language :: Python :: 3.8',
+        'Topic :: Text Processing'
     ],
     entry_points={"console_scripts": [
         "pvl_translate = pvl.pvl_translate:main",