Merge branch 'release/1.1.0'

Author: scolby33

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 1.0.2
+current_version = 1.1.0
 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-]+)*))?

.gitignore

@@ -45,6 +45,8 @@ coverage.xml
 *,cover
 .hypothesis/
 
+.pytest_cache/
+
 # Translations
 *.mo
 *.pot

.travis.yml

@@ -4,31 +4,21 @@ cache: pip
 language: python
 
 python:
-    - "2.7"
-    - "3.3"
-    - "3.4"
-    - "3.5"
-    - "3.6"
+    - 3.6
+    - 3.5
+    - 3.4
+    - 3.3
+    - 2.7
+
 env:
-    - TOXENV=manifest
-    - TOXENV=docs
+  - TOXENV=py
+  - TOXENV=docs
+  - TOXENV=manifest
 
 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.6"
-          env: TOXENV=py36
     allow_failures:
-        - python: "3.3"
-        - python: "3.4"
-        - python: "3.6"
+        - python: 3.4
+        - python: 3.3
 
 before_install:
     - pip install codecov

AUTHORS.rst

@@ -6,4 +6,5 @@ Authors
 Contributors
 ------------
 
+- Arno Hautala <[email protected]>: image attachment support
 - Your Name <email or twitter handle>: short description of your contribution, if you want

LICENSE.rst

@@ -1,7 +1,7 @@
 MIT License
 ===========
 
-Copyright (c) 2016 Scott Colby
+Copyright (c) 2018 Scott Colby
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.rst

@@ -16,7 +16,7 @@ Development |develop_build| |develop_coverage| |develop_documentation| |develop_
 .. |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
+.. |stable_pyversions| image:: https://img.shields.io/badge/python-2.7%2C%203.5%2C%203.6-blue.svg
     :alt: Stable Supported Python Versions
 
 
@@ -29,7 +29,7 @@ Development |develop_build| |develop_coverage| |develop_documentation| |develop_
 .. |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
+.. |develop_pyversions| image:: https://img.shields.io/badge/python-2.7%2C%203.5%2C%203.6-blue.svg
     :alt: Development Supported Python Versions
 
 To learn more about Pushover and the Pushover API, please visit the Pushover Website, `<https://pushover.net>`_.
@@ -53,10 +53,14 @@ 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.
+:code:`pushover_complete` officially supports Python 2.7, 3.5, and 3.6.
 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.
+Additionally, due to changes in Sphinx, the documentation cannot be built with Python 3.3.
+
+As of version 1.1.0, support for Python 3.5 is deprecated. It will be removed in the next major version release.
+This doesn't mean that Python 3.5 will stop working immediately, but I will no longer consider failing tests for that version to be critical.
 
+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
 ------------
@@ -69,7 +73,17 @@ The full list of contributors is in :code:`AUTHORS.rst` or `on GitHub <https://g
 Changelog
 ---------
 
-Changes as of 23 December 2016
+Changes as of 6 April 2018
+
+1.1.0 <6 April 2018>
+^^^^^^^^^^^^^^^^^^^^
+
+- Add `image attachment support <https://pushover.net/api#attachments>`_ (Pulls `#5 <https://github.com/scolby33/pushover_complete/pull/5>`_ and `#9 <https://github.com/scolby33/pushover_complete/pull/9>`_)
+- Officially add support for Python 3.6
+- Change default tox environment for Python 3 to py36
+- Refactored :code:`.travis.yml` to be more concise and use the new :code:`py` `environment specification <https://tox.readthedocs.io/en/3.0.0/example/basic.html#a-simple-tox-ini-default-environments>`_ (Pull `#8 <https://github.com/scolby33/pushover_complete/pull/8>`_)
+- Some refactoring in the main API (more list comprehensions yay!) (Pull `#6 <https://github.com/scolby33/pushover_complete/pull/6>`_)
+- Several small documentation changes/refinements
 
 1.0.2 <23 December 2016>
 ^^^^^^^^^^^^^^^^^^^^^^^^

docs/source/changelog.rst

@@ -15,7 +15,18 @@ 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.
 
-Changes as of 23 December 2016
+Changes as of 6 April 2018
+
+1.1.0 <6 April 2018>
+^^^^^^^^^^^^^^^^^^^^
+
+- Add `image attachment support <https://pushover.net/api#attachments>`_ (Pulls `#5 <https://github.com/scolby33/pushover_complete/pull/5>`_ and `#9 <https://github.com/scolby33/pushover_complete/pull/9>`_)
+- Officially add support for Python 3.6
+- Officially deprecate support for Python 3.5. It will be removed in the next major version release.
+- Change default tox environment for Python 3 to py36
+- Refactored :code:`.travis.yml` to be more concise and use the new :code:`py` `environment specification <https://tox.readthedocs.io/en/3.0.0/example/basic.html#a-simple-tox-ini-default-environments>`_ (Pull `#8 <https://github.com/scolby33/pushover_complete/pull/8>`_)
+- Some refactoring in the main API (more list comprehensions yay!) (Pull `#6 <https://github.com/scolby33/pushover_complete/pull/6>`_)
+- Several small documentation changes/refinements
 
 1.0.2 <23 December 2016>
 ^^^^^^^^^^^^^^^^^^^^^^^^

docs/source/conf.py

@@ -66,7 +66,7 @@
 # built documents.
 #
 # The full version, including alpha/beta/rc tags.
-release = '1.0.2'
+release = '1.1.0'
 # The short X.Y version.
 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)

docs/source/contributing.rst

@@ -42,7 +42,7 @@ Here's how to get set up to contribute to :code:`pushover_complete`.
 
     $ pipsi install tox
     # or
-    $ pyvenv my-virtual-env
+    $ python -m venv my-virtual-env
     $ source my-virtual-env/bin/activate
     $ pip install tox
     # or
@@ -181,24 +181,31 @@ The steps for making a release of :code:`pushover_complete` are:
 
 #. Run all tests one last time! ::
 
-    $ tox
+    $ tox -r
 
+   .. note:: I'm using the :code:`-r` option here, forcing tox to recreate all its virtual environments to be sure this is a "clean" build.
+        It takes longer but I think it's worth it for the peace of mind.
 #. Build the project::
 
     $ python setup.py sdist bdist_wheel
 
-#. Check that the sdist and wheel install properly::
+#. Check that the sdist and wheel install properly
+
+   .. warning:: Make sure you do not have any activated virtual environments when running these and the similar test steps.
+        I've gotten inconsistent results in that situation.
+
+   ::
 
     $ rm -r tmp-virtualenv
-    $ pyvenv tmp-virtualenv
-    $ tmp-virtualenv/bin/pip install dist/pushover_complete-{new-version}.tar.gz
+    $ python -m venv tmp-virtualenv
+    $ tmp-virtualenv/bin/python -m pip install dist/pushover_complete-{new-version}.tar.gz
     $ tmp-virtualenv/bin/python
     >>> import pushover_complete
     >>> pushover_complete.__version__
     '{new_version}'
     $ rm -rf tmp-virtualenv
-    $ pyvenv tmp-virtualenv
-    $ tmp-virtualenv/bin/pip install dist/pushover_complete-{new-version}-py2.py3-none-any.whl
+    $ python -m venv tmp-virtualenv
+    $ tmp-virtualenv/bin/python -m pip install dist/pushover_complete-{new-version}-py2.py3-none-any.whl
     $ tmp-virtualenv/bin/python
     >>> import pushover_complete
     >>> pushover_complete.__version__
@@ -207,7 +214,6 @@ The steps for making a release of :code:`pushover_complete` are:
 
 #. 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::
@@ -223,7 +229,6 @@ The steps for making a release of :code:`pushover_complete` are:
          password = password
 
          [pypi]
-         repository = https://pypi.python.org/pypi
          username = username
          password = password
 
@@ -232,8 +237,8 @@ The steps for making a release of :code:`pushover_complete` are:
 #. Test install from the test PyPI::
 
     $ rm -rf tmp-virtualenv
-    $ pyvenv tmp-virtualenv
-    $ tmp-virtualenv/bin/pip install -i https://testpypi.python.org/pypi pushover_complete
+    $ python -m venv tmp-virtualenv
+    $ tmp-virtualenv/bin/python -m pip install -i https://testpypi.python.org/pypi pushover_complete
     $ tmp-virtualenv/bin/python
     >>> import pushover_complete
     >>> pushover_complete.__version__
@@ -242,19 +247,15 @@ The steps for making a release of :code:`pushover_complete` are:
 
 #. Check the metadata and such on the test PyPI website
 #. Deep breath
-#. 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
-    $ pyvenv tmp-virtualenv
-    $ tmp-virtualenv/bin/pip install pushover_complete
+    $ python -m venv tmp-virtualenv
+    $ tmp-virtualenv/bin/python -m pip install pushover_complete
     $ tmp-virtualenv/bin/python
     >>> import pushover_complete
     >>> pushover_complete.__version__

docs/source/index.rst

@@ -16,7 +16,9 @@ Welcome to :mod:`pushover_complete`
 
 :mod:`pushover_complete` is a Python package for interacting with *all* aspects of the `Pushover API <https://pushover.net/api>`_.
 
-.. =========== =============== ================== ======================= ====================
+.. only:: not latex
+
+    =========== =============== ================== ======================= ====================
     Stable      |stable_build|  |stable_coverage|  |stable_documentation|  |stable_pyversions|
     Development |develop_build| |develop_coverage| |develop_documentation| |develop_pyversions|
     =========== =============== ================== ======================= ====================
@@ -43,7 +45,7 @@ Welcome to :mod:`pushover_complete`
     .. |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
+    .. |develop_pyversions| image:: https://img.shields.io/badge/python-2.7%2C%203.5%2C%203.6-blue.svg
         :alt: Development Supported Python Versions
 
 To learn more about Pushover and the Pushover API, please visit the Pushover Website, `<https://pushover.net>`_.
@@ -85,8 +87,14 @@ Downloading and installing from source goes like this::
 
 If you intend to install in a virtual environment, activate it before running :code:`pip install`.
 
-:mod:`pushover_complete` officially supports Python 2.7 and 3.5.
+:mod:`pushover_complete` officially supports Python 2.7, 3.5, and 3.6.
 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.
+Additionally, due to changes in Sphinx, the documentation cannot be built with Python 3.3.
+
+.. warning::
+    .. deprecated:: 1.1.0 Support for Python 3.5 is deprecated. It will be removed in the next major version release.
+        This doesn't mean that Python 3.5 will stop working immediately, but I will no longer consider failing tests for that version to be critical.
+
 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.
 
 See :ref:`installation` for further information about installing :mod:`pushover_complete` in all manner of ways.
@@ -160,7 +168,7 @@ 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.
 
-The current version of :mod:`pushover_complete` is |release|.
+You are reading the documents for version |release| of :mod:`pushover_complete`.
 
 Full changelogs can be found on the :ref:`changelog` page.
 

docs/source/installation.rst

@@ -11,9 +11,9 @@
 Installation
 ============
 
-There are many ways to install a Python package like :code:`pushover_complete`. Here many of those will be explained and the advantages of each will be identified.
+There are many ways to install a Python package like :mod:`pushover_complete`. Here many of those will be explained and the advantages of each will be identified.
 
-If you are not yet familiar with virtual environments, stop reading this documentation and take a few moments to learn. Try some searches for "virtualenv," "virtualenvwrapper," and "pyvenv."
+If you are not yet familiar with virtual environments, stop reading this documentation and take a few moments to learn. Try some searches for "virtualenv," "virtualenvwrapper," and the "venv" standard library module.
 I promise that they will change your (Python) life.
 
 Where to Get the Code
@@ -22,7 +22,7 @@ Where to Get the Code
 From PyPI
 ^^^^^^^^^
 
-Stable releases of :code:`pushover_complete` are located on PyPI, the `PYthon Package Index <https://pypi.python.org/pypi>`_.
+Stable releases of :mod:`pushover_complete` are located on PyPI, the `PYthon Package Index <https://pypi.python.org/pypi>`_.
 Installation from here is easy and generally the preferred method::
 
     $ pip install pushover_complete
@@ -37,7 +37,7 @@ From GitHub
 
 This works because only release-ready code is pushed to the master branch.
 
-To get the latest and greatest version of :code:`pushover_complete` from the develop branch, install like this instead::
+To get the latest and greatest version of :mod:`pushover_complete` from the develop branch, install like this instead::
 
     $ pip install git+https://github.com/scolby33/pushover_complete@develop#egg=pushover_complete-latestdev
 

docs/source/license.rst

@@ -15,7 +15,7 @@ This software is licensed under the MIT License. The full text of this license i
 
 MIT License
 
-Copyright (c) 2016 Scott Colby
+Copyright (c) 2018 Scott Colby
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

docs/source/roadmap.rst

@@ -27,6 +27,8 @@ The following Pushover API endpoints are fully implemented:
 
 This constitutes all of the API endpoints available for entities acting as Pushover applications.
 
-A command line interface is in the works to allow use directly from the shell.
+.. versionadded:: 1.1.0 Additionally, the `image attachment functionality <https://pushover.net/api#attachments>`_ added to Pushover in January 2018 `with version 3.0 of the Pushover apps <https://updates.pushover.net/post/170043375237/pushing-images-with-pushover-30>`_ is now supported.
+
+A command line interface is in the works to allow use directly from your shell.
 
 The Pushover Open Client API may be implemented for a future release.

setup.py

@@ -4,6 +4,7 @@
 import codecs  # To use a consistent encoding
 import os
 import re
+import sys
 
 #################################################################
 
@@ -20,7 +21,9 @@
     'Programming Language :: Python :: 3.5',
     'Topic :: Communications'
 ]
-INSTALL_REQUIRES = ['requests']
+INSTALL_REQUIRES = ['requests', 'six']
+if sys.version_info < (3, 4):  # pathlib added to stdlib in 3.4
+    INSTALL_REQUIRES.append('pathlib2')
 EXTRAS_REQUIRE = {}
 TESTS_REQUIRE = ['tox']
 

src/pushover_complete/__init__.py

@@ -8,7 +8,7 @@
     'PushoverAPI'
 ]
 
-__version__ = '1.0.2'
+__version__ = '1.1.0'
 
 __title__ = 'pushover_complete'
 __description__ = 'A Python package for interacting with *all* aspects of the Pushover API'