Merge branch 'release/1.0.1'

Author: scolby33

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 1.0.0
+current_version = 1.0.1
 commit = True
 tag = False
 parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(?:-(?P<release>[0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*))?(?:\+(?P<build>[0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*))?

.codecov.yml

@@ -0,0 +1,3 @@
+codecov:
+    branch: develop
+

.travis.yml

@@ -1,18 +1,30 @@
 sudo: false
-cache:
-    directories:
-        - $HOME/.cache/pip
+cache: pip
 
 language: python
 
+python:
+    - "2.7"
+    - "3.3"
+    - "3.4"
+    - "3.5"
+env:
+    - TOXENV=manifest
+    - TOXENV=docs
+
 matrix:
     include:
+        - python: "2.7"
+          env: TOXENV=py27
+        - python: "3.3"
+          env: TOXENV=py33
+        - python: "3.4"
+          env: TOXENV=py34
         - python: "3.5"
           env: TOXENV=py35
-        - python: "3.5"
-          env: TOXENV=manifest
-        - python: "3.5"
-          env: TOXENV=docs
+    allow_failures:
+        - python: "3.3"
+        - python: "3.4"
 
 before_install:
     - pip install codecov

MANIFEST.in

@@ -1,8 +1,9 @@
 include *.rst
-include tox.ini
 
 include .bumpversion.cfg
+include .codecov.yml
 include .coveragerc
+include tox.ini
 
 recursive-include tests *.py
 

README.rst

@@ -1,16 +1,36 @@
 pushover_complete
 =================
-A Python 3 package for interacting with *all* aspects of the Pushover API.
+A Python package for interacting with *all* aspects of the Pushover API.
 
-.. image:: https://travis-ci.org/scolby33/pushover_complete.svg?branch=master
+=========== =============== ================== ======================= ====================
+Stable      |stable_build|  |stable_coverage|  |stable_documentation|  |stable_pyversions|
+Development |develop_build| |develop_coverage| |develop_documentation| |develop_pyversions|
+=========== =============== ================== ======================= ====================
+
+.. |stable_build| image:: https://travis-ci.org/scolby33/pushover_complete.svg?branch=master
     :target: https://travis-ci.org/scolby33/pushover_complete
-    :alt: Build Status
-.. image:: https://codecov.io/github/scolby33/pushover_complete/coverage.svg?branch=master
+    :alt: Stable Build Status
+.. |stable_coverage| image:: https://codecov.io/github/scolby33/pushover_complete/coverage.svg?branch=master
     :target: https://codecov.io/github/scolby33/pushover_complete?branch=master
-    :alt: Test Coverage Status
-.. image:: http://readthedocs.org/projects/pushover-complete/badge/?version=latest
-    :target: http://pushover-complete.readthedocs.io/en/latest/?badge=latest
-    :alt: Documentation Status
+    :alt: Stable Test Coverage Status
+.. |stable_documentation| image:: http://readthedocs.org/projects/pushover-complete/badge/?version=stable
+    :target: http://pushover-complete.readthedocs.io/en/stable/?badge=stable
+    :alt: Stable Documentation Status
+.. |stable_pyversions| image:: https://img.shields.io/badge/python-2.7%2C%203.5-blue.svg
+    :alt: Stable Supported Python Versions
+
+
+.. |develop_build| image:: https://travis-ci.org/scolby33/pushover_complete.svg?branch=develop
+    :target: https://travis-ci.org/scolby33/pushover_complete
+    :alt: Development Build Status
+.. |develop_coverage| image:: https://codecov.io/github/scolby33/pushover_complete/coverage.svg?branch=develop
+    :target: https://codecov.io/github/scolby33/pushover_complete?branch=develop
+    :alt: Development Test Coverage Status
+.. |develop_documentation| image:: http://readthedocs.org/projects/pushover-complete/badge/?version=develop
+    :target: http://pushover-complete.readthedocs.io/en/develop/?badge=develop
+    :alt: Development Documentation Status
+.. |develop_pyversions| image:: https://img.shields.io/badge/python-2.7%2C%203.5-blue.svg
+    :alt: Development Supported Python Versions
 
 To learn more about Pushover and the Pushover API, please visit the Pushover Website, `<https://pushover.net>`_.
 
@@ -33,6 +53,11 @@ Installation should be as easy as executing this command in your chosen terminal
 
     $ pip install pushover_complete
 
+:code:`pushover_complete` officially supports Python 2.7 and 3.5.
+Currently, Python 3.3 and 3.4 pass all tests and function properly as well, but this could change: these versions are not officially targeted by development.
+Support for Python 2.x may be dropped in the future, but only in a major version update (e.g. 1.x.y → 2.x.y) and this change will be announced well in advance.
+
+
 Contributing
 ------------
 
@@ -44,7 +69,15 @@ The full list of contributors is in :code:`AUTHORS.rst` or `on GitHub <https://g
 Changelog
 ---------
 
-1.0.0 <2016-05-09>
+Changes as of 10 May 2016
+
+1.0.1 <10 May 2016>
+^^^^^^^^^^^^^^^^^^^
+
+- Officially add Python 2.7 support and add testing for it to tox and Travis
+- Numerous updates to documentation and README, etc. to make them prettier and more useful
+
+1.0.0 <9 May 2016>
 ^^^^^^^^^^^^^^^^^^
 
 - Implementation of methods for the Pushover messages, sounds, users, receipt, subscriptions, groups, and licenses APIs

docs/source/api.rst

@@ -1,3 +1,11 @@
+.. only:: prerelease
+
+    .. warning:: This is the documentation for a development version of pushover_complete.
+
+        .. only:: readthedocs
+
+            `Documentation for the Most Recent Stable Version <http://pushover-complete.readthedocs.io/en/stable/>`_
+
 .. _api:
 
 API Reference

docs/source/changelog.rst

@@ -1,3 +1,11 @@
+.. only:: prerelease
+
+    .. warning:: This is the documentation for a development version of pushover_complete.
+
+        .. only:: readthedocs
+
+            `Documentation for the Most Recent Stable Version <http://pushover-complete.readthedocs.io/en/stable/>`_
+
 .. _changelog:
 
 Changelog
@@ -7,6 +15,13 @@ Changelog
 Details about this versioning scheme can be found on the `Semver website <http://semver.org/spec/v2.0.0.html>`_.
 Versions postfixed with '-dev' are currently under development and those without a postfix are stable releases.
 
-- :release:`1.0.0 <2016-05-09>`
+.. note:: Links to future releases are currently broken due to how the changelog is parsed.
+   To see the most recent changes, `visit the GitHub repository <https://github.com/scolby33/pushover_complete/tree/develop>`_.
+   I am working on a fix for this issue.
+
+- :release:`1.0.1 <10 May 2016>`
+- :support:`-` Numerous updates to documentation and README, etc. to make them prettier and more useful
+- :support:`-` Officially add Python 2.7 support and add testing for it to tox and Travis
+- :release:`1.0.0 <9 May 2016>`
 - :feature:`-` Documentation and build process
 - :feature:`-` Implementation of methods for the Pushover messages, sounds, users, receipt, subscriptions, groups, and licenses APIs

docs/source/conf.py

@@ -66,10 +66,14 @@
 # built documents.
 #
 # The full version, including alpha/beta/rc tags.
-release = '1.0.0'
+release = '1.0.1'
 # The short X.Y version.
-version = re.sub('(?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(?:-(?P<release>[0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*))?(?:\+(?P<build>[0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*))?',
-                 '\g<major>.\g<minor>.\g<patch>', release)  # get the version number without any alpha/beta/rc/etc. tags
+parsed_version = re.match('(?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(?:-(?P<release>[0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*))?(?:\+(?P<build>[0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*))?',
+                          release)
+version = parsed_version.expand('\g<major>.\g<minor>.\g<patch>')
+
+if parsed_version.group('release'):
+    tags.add('prerelease')
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -299,6 +303,10 @@
 # If true, do not generate a @detailmenu in the "Top" node's menu.
 #texinfo_no_detailmenu = False
 
+# Suppress warnings about nonlocal image URIs
+suppress_warnings = [
+    'image.nonlocal_uri'
+]
 
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {
@@ -310,4 +318,9 @@
 
 
 # 'releases' (changelog) configuration
+releases_release_uri = 'https://github.com/scolby33/pushover_complete/releases/tag/v%s'
+# releases_future_release_uri = 'https://github.com/scolby33/pushover_complete/tree/develop'
 releases_github_path = 'scolby33/pushover_complete'
+
+if os.environ.get('READTHEDOCS', None):
+    tags.add('readthedocs')

docs/source/contributing.rst

@@ -1,3 +1,11 @@
+.. only:: prerelease
+
+    .. warning:: This is the documentation for a development version of pushover_complete.
+
+        .. only:: readthedocs
+
+            `Documentation for the Most Recent Stable Version <http://pushover-complete.readthedocs.io/en/stable/>`_
+
 .. _contributing:
 
 Contributing
@@ -158,23 +166,32 @@ The steps for making a release of :code:`pushover_complete` are:
 #. Create a release branch::
 
      $ git flow release start {new_version}
+
 #. Bump the version specifier in :code:`src/pushover_complete/__init__.py` and :code:`docs/source/conf.py` from '{new_version}-dev' to plain '{new_version}'::
 
     $ bumpversion release
+
 #. Add a release entry in :code:`docs/source/changelog.rst` (something like :code:`- :release:`{new_version} <date>``)
-#. Update :code:`README.rst` with new version and changelog information
-#. Check that any new intersphinx links have corresponding inventories in :code:`docs/source/conf.py`::
+#. Update :code:`README.rst` with new version and changelog information, including the last updated date in the changelog
+#. Check that any new intersphinx links have corresponding inventory locations in :code:`docs/source/conf.py`. Run
+
+    ::
+
+    $ egrep -rIn --exclude-dir=.eggs --exclude-dir=.tox --exclude-dir=build ':\S+:' .
+
+   and check for instances of :code:`:meth:`, :code:`:class:`, etc. that are from sources not already included in :code:`intersphinx_mapping` in :code:`conf.py`. (There will be a lot of lines, but with :code:`grep` coloring turned on, it's not that hard to skim through relatively quickly.)
 
-    $ egrep -rn --exclude-dir=__pycache__ ':\S+:' .
 #. Run all tests one last time! ::
 
     $ tox
+
 #. Build the project::
 
     $ python setup.py sdist bdist_wheel
+
 #. Check that the sdist and wheel install properly::
 
-    $ rm -rf tmp-virtualenv
+    $ rm -r tmp-virtualenv
     $ pyvenv tmp-virtualenv
     $ tmp-virtualenv/bin/pip install dist/pushover_complete-{new-version}.tar.gz
     $ tmp-virtualenv/bin/python
@@ -183,16 +200,37 @@ The steps for making a release of :code:`pushover_complete` are:
     '{new_version}'
     $ rm -rf tmp-virtualenv
     $ pyvenv tmp-virtualenv
-    $ tmp-virtualenv/bin/pip install dist/pushover_complete-{new-version}....whl
+    $ tmp-virtualenv/bin/pip install dist/pushover_complete-{new-version}-py2.py3-none-any.whl
     $ tmp-virtualenv/bin/python
     >>> import pushover_complete
     >>> pushover_complete.__version__
     '{new_version}'
     $ rm -rf tmp-virtualenv
+
 #. Try a release on the PyPI test server::
 
     $ python setup.py register -r test
     $ twine upload -r test dist/pushover_complete-{new_version}*
+
+   .. note:: This requires a :code:`.pypirc` file in your home folder::
+
+         [distutils]
+         index-servers=
+             pypi
+             test
+
+         [test]
+         repository = https://testpypi.python.org/pypi
+         username = username
+         password = password
+
+         [pypi]
+         repository = https://pypi.python.org/pypi
+         username = username
+         password = password
+
+     Registration with PyPI and TestPyPI is required.
+
 #. Test install from the test PyPI::
 
     $ rm -rf tmp-virtualenv
@@ -203,14 +241,17 @@ The steps for making a release of :code:`pushover_complete` are:
     >>> pushover_complete.__version__
     '{new_version}'
     $ rm -rf tmp-virtualenv
-#. Check the metadata and such on the test PyPI web interface
+
+#. Check the metadata and such on the test PyPI website
 #. Deep breath
-#. Register on PyPI if necessary::
+#. Register on PyPI::
 
     $ python setup.py register
+
 #. Upload to PyPI! ::
 
     $ twine upload dist/pushover_complete-{new_version}*
+
 #. Test install from PyPI::
 
     $ rm -rf tmp-virtualenv
@@ -221,18 +262,23 @@ The steps for making a release of :code:`pushover_complete` are:
     >>> pushover_complete.__version__
     '{new_version}'
     $ rm -rf tmp-virtualenv
+
 #. Check the metadata and such on the PyPI website
 #. Publish the release branch::
 
     $ git flow release publish {new_version}
+
 #. Finish the release branch::
 
-    $ git flow release finish -F {new_version}
+    $ git flow release finish {new_version}
+
 #. Push the new tag::
 
     $ git push --tags
-#. Upload the sdist and wheel to the release on GitHub
-#. Add a pretty changelog to the release on GitHub
+
+#. Attach the sdist and wheel files to the release on GitHub
+#. Add changelog notes to the release on GitHub
 #. Bump the version to the next dev version::
 
     $ bumpversion patch
+