WIP: Enable pre-release builds from dev branch

* Add function to get a pre-release version number, only for Travis jobs on the dev branch
* Add separate deploy target for dev branch only
* Add separate 'build' setuptools extra for build-specific packages
* Remove `twine` from dependencies since Travis uses this already
* Add `semantic-version` package, only used for Travis pre-release builds
    * Note: Also added this to dev dependencies, but only because there are unit tests for
      the Travis CI pre-release version numbers
* Move `mypy.ini` config into `setup.cfg`
* Add badges for package format and supported python version
* Update pypi version badge to match the format/resolution of the others

.travis.yml

@@ -16,22 +16,34 @@ matrix:
     env: TOXENV=coverage,mypy,style
 
 # Install dependencies & run tests
-install: 
-  - pip install tox-travis coveralls
-script:
-  - tox
+install: pip install ".[build]"
+script: tox
 # Run coveralls after 'coverage' env
-after_success:
-  - if [[ $TOXENV == *"coverage"* ]]; then coveralls; fi
+after_success: if [[ $TOXENV == *"coverage"* ]]; then coveralls; fi
+
+#env:
+#  global: PYPI_TOKEN=
 
-# Deploy to PyPI on git tags only (and master branch only by default)
 deploy:
-  provider: pypi
-  user: __token__
-  password:
-    secure: s7FY53bvG0e+xS/pVQC+SX/eGnZR7alAqpE3n6HZvGQec0kGCE3VofCpGVUyguUiUGmm027xIIdSq6Gpx+lBhWRGmf36RDUAaBOV2DVCgEdPf8nX8Gv4vinOepXWVTYal7QNXiDZCiryyA2O+/28A4abGTS37w+zUQyM70UgJwI9hO1zC4dj4maDY2WE1XHS0WHuI3+iRYc/48d5Pc58gDuGWB4adZ7lODB81/d6StxVJkFCCcVcDwpOAJPldHywULxhfQDu3+vwfchP0V7bMOd+eBwK799gfXERmuZROqxVRuNSRgd8a+TBOzOL7ckW66xyCBN+PT8sVro3P6ZJ9FE65f+opS+9Nz+nUK4Y7QhRNu8D4aUpwfJW8UrxUVl474Ni5YqdSPaARHzJsRi2H+Ft288mawzctsoV6xY/LUDh9d+p+qFR3BTVwyUnQC9NcrrBJl9CnHlsqMH2BXSP5Hr+UCP0Mnjq8UqBRIxk4WSx+4UmrtDzSAO4q1GA/Zo9SaXUyl2D/TodpkWqhgYJ9SdcyXITIhMISTCOtOAVHs1dzYkwKNf2Y+rvopfFXS037sAQm+k9MxyBpQyYaObZj+HS/k/QVwuIWOncyZOqcSb/DrLGiwEVe2aTSg/7YEFshnp0tswDhsNLv6jT9gRd4cB+cnVv3siZisvPpYIamH0=
-  distributions: sdist bdist_wheel
-  skip_cleanup: true
-  skip_existing: true
-  on:
-    tags: true
+  # Stable releases: only git tags on master branch
+  - provider: pypi
+    user: __token__
+    password:
+      secure: $PYPI_TOKEN
+    distributions: sdist bdist_wheel
+    skip_cleanup: true
+    skip_existing: true
+    on:
+      tags: true
+      python: "3.8"
+  # Pre-releases: dev branch only; pre-release version number is set in __init__.py
+  - provider: pypi
+    user: __token__
+    password:
+      secure: s7FY53bvG0e+xS/pVQC+SX/eGnZR7alAqpE3n6HZvGQec0kGCE3VofCpGVUyguUiUGmm027xIIdSq6Gpx+lBhWRGmf36RDUAaBOV2DVCgEdPf8nX8Gv4vinOepXWVTYal7QNXiDZCiryyA2O+/28A4abGTS37w+zUQyM70UgJwI9hO1zC4dj4maDY2WE1XHS0WHuI3+iRYc/48d5Pc58gDuGWB4adZ7lODB81/d6StxVJkFCCcVcDwpOAJPldHywULxhfQDu3+vwfchP0V7bMOd+eBwK799gfXERmuZROqxVRuNSRgd8a+TBOzOL7ckW66xyCBN+PT8sVro3P6ZJ9FE65f+opS+9Nz+nUK4Y7QhRNu8D4aUpwfJW8UrxUVl474Ni5YqdSPaARHzJsRi2H+Ft288mawzctsoV6xY/LUDh9d+p+qFR3BTVwyUnQC9NcrrBJl9CnHlsqMH2BXSP5Hr+UCP0Mnjq8UqBRIxk4WSx+4UmrtDzSAO4q1GA/Zo9SaXUyl2D/TodpkWqhgYJ9SdcyXITIhMISTCOtOAVHs1dzYkwKNf2Y+rvopfFXS037sAQm+k9MxyBpQyYaObZj+HS/k/QVwuIWOncyZOqcSb/DrLGiwEVe2aTSg/7YEFshnp0tswDhsNLv6jT9gRd4cB+cnVv3siZisvPpYIamH0=
+    distributions: sdist
+    skip_cleanup: true
+    skip_existing: true
+    on:
+      branch: build-test
+      python: "3.8"

README.rst

@@ -2,19 +2,23 @@
 pyinaturalist
 =============================
 
-.. image:: https://badge.fury.io/py/pyinaturalist.png
-    :target: http://badge.fury.io/py/pyinaturalist
-
 .. image:: https://www.travis-ci.com/niconoe/pyinaturalist.svg?branch=master
     :target: https://www.travis-ci.com/niconoe/pyinaturalist
-
+    :alt: Build Status
 .. image:: https://readthedocs.org/projects/pyinaturalist/badge/?version=latest
     :target: https://pyinaturalist.readthedocs.io/en/latest/?badge=latest
     :alt: Documentation Status
-
 .. image:: https://coveralls.io/repos/github/niconoe/pyinaturalist/badge.svg?branch=dev
     :target: https://coveralls.io/github/niconoe/pyinaturalist?branch=dev
-
+.. image:: https://img.shields.io/pypi/v/pyinaturalist?color=blue
+    :target: https://pypi.org/project/pyinaturalist
+    :alt: PyPI
+.. image:: https://img.shields.io/pypi/pyversions/pyinaturalist
+    :target: https://pypi.org/project/pyinaturalist
+    :alt: PyPI - Python Version
+.. image:: https://img.shields.io/pypi/format/pyinaturalist?color=blue
+    :target: https://pypi.org/project/pyinaturalist
+    :alt: PyPI - Format
 
 Python client for the `iNaturalist APIs <https://www.inaturalist.org/pages/api+reference>`_.
 

pyinaturalist/__init__.py

@@ -1,14 +1,38 @@
-import logging
+from logging import getLogger
+from os import getenv
 
 __author__ = "Nicolas Noé"
 __email__ = "nicolas@niconoe.eu"
-__version__ = "0.9.1"
+__version__ = "0.10.0"
+
+# These are imported here so they can be set with pyinaturalist.<variable>
+from pyinaturalist.constants import DRY_RUN_ENABLED, DRY_RUN_WRITE_ONLY
 
 DEFAULT_USER_AGENT = "Pyinaturalist/{version}".format(version=__version__)
 user_agent = DEFAULT_USER_AGENT
 
-# These are imported here so they can be set with pyinaturalist.<variable>
-from pyinaturalist.constants import DRY_RUN_ENABLED, DRY_RUN_WRITE_ONLY
 
-# Enable logging for urllib and other external loggers
-logging.basicConfig(level="DEBUG")
+def get_prerelease_version(version: str) -> str:
+    """ If we're running in a Travis CI job on the dev branch, get a prerelease version using the
+    current build number. For example: ``1.0.0 -> 1.0.0-dev+123``
+
+    This could also be done in ``.travis.yml``, but it's a bit cleaner to do in python, and
+    ``semantic_version`` provides some extra sanity checks.
+    """
+    if not (getenv("TRAVIS") == "true" and getenv("TRAVIS_BRANCH") == "build-test"):
+        return version
+    # If we happen to be in a dev build, this will prevent the initial 'pip install' from failing
+    try:
+        from semantic_version import Version
+    except ImportError:
+        return version
+
+    new_version = Version(version)
+    new_version.prerelease = ["dev"]
+    new_version.build = [getenv("TRAVIS_BUILD_NUMBER", "0")]
+    getLogger(__name__).info("Using pre-release version: {}".format(new_version))
+    return str(new_version)
+
+
+# This won't modify the version outside of Travis
+__version__ = get_prerelease_version(__version__)

setup.cfg

@@ -15,5 +15,18 @@ classifiers =
     Programming Language :: Python :: 3.6
     Programming Language :: Python :: 3.7
 
+# Tell mypy to ignore external libraries without type annotations
+[mypy-pytest]
+ignore_missing_imports = True
+
+[mypy-requests_mock]
+ignore_missing_imports = True
+
+[mypy-semantic_version]
+ignore_missing_imports = True
+
+[mypy-setuptools]
+ignore_missing_imports = True
+
 [wheel]
 universal = 1

setup.py

@@ -15,18 +15,19 @@
     extras_require={
         "dev": [
             "black",
-            "coveralls",
             "flake8",
             "mypy",
             "pytest",
             "pytest-cov",
             "requests-mock>=1.7",
+            "semantic-version",
             "Sphinx",
             "sphinx-autodoc-typehints",
             "sphinx-rtd-theme",
             "tox",
-            "twine",
-        ]
+        ],
+        # Additional packages used only within CI jobs
+        "build": ["coveralls", "semantic-version", "tox-travis"],
     },
     zip_safe=False,
 )

test/conftest.py

@@ -3,12 +3,15 @@
 Pytest will also automatically pick up any fixtures defined here.
 """
 import json
+import logging
 import os
 import re
 from inspect import getmembers, isfunction, signature, Parameter
 from unittest.mock import MagicMock
 
 HTTP_FUNC_PATTERN = re.compile(r"(get|put|post|delete)_.+")
+# Enable logging for urllib and other external loggers
+logging.basicConfig(level="INFO")
 
 
 def get_module_functions(module):

test/test_version.py

@@ -0,0 +1,21 @@
+# A couple tests to make sure that versioning works as expected within Travis
+# So, for example, the build would fail before accidentally publishing a bad version
+from sys import version_info
+from unittest.mock import patch
+import pytest
+
+
+# Mocking out getenv() instead of actually setting envars so this doesn't affect other tests
+@patch("pyinaturalist.getenv", side_effect=["true", "master", "123"])
+def test_version__stable_release(mock_getenv):
+    import pyinaturalist
+
+    assert "dev" not in pyinaturalist.__version__
+
+
+@pytest.mark.skipif(version_info < (3, 6), reason="semantic-version requires python >= 3.6")
+@patch("pyinaturalist.getenv", side_effect=["true", "build-test", "123"])
+def test_version__pre_release(mock_getenv):
+    import pyinaturalist
+
+    assert pyinaturalist.get_prerelease_version("1.0.0") == "1.0.0-dev+123"

tox.ini

@@ -21,7 +21,7 @@ commands =
 
 [testenv:mypy]
 commands =
-    mypy --config-file={toxinidir}/mypy.ini .
+    mypy --config-file={toxinidir}/setup.cfg .
     printf '====================\n\n'
 
 [testenv:style]