Setup pypi automatic publishing.

.travis.yml

@@ -2,36 +2,53 @@ dist: xenial
 language: python
 sudo: false
 services:
-  - docker
+- docker
 python:
-  - 2.7
-  - 3.6
-  - 3.7
+- 2.7
+- 3.6
+- 3.7
 env:
-    - TEST_SERVER_MODE=false
-    - TEST_SERVER_MODE=true
+- TEST_SERVER_MODE=false
+- TEST_SERVER_MODE=true
 before_install:
-  - export BOTO_CONFIG=/dev/null
+- export BOTO_CONFIG=/dev/null
 install:
-  # We build moto first so the docker container doesn't try to compile it as well, also note we don't use
-  # -d for docker run so the logs show up in travis
-  # Python images come from here: https://hub.docker.com/_/python/
-  - |
-    python setup.py sdist
+- |
+  python setup.py sdist
 
-    if [ "$TEST_SERVER_MODE" = "true" ]; then
-      docker run --rm -t --name motoserver -e TEST_SERVER_MODE=true -e AWS_SECRET_ACCESS_KEY=server_secret -e AWS_ACCESS_KEY_ID=server_key -v `pwd`:/moto -p 5000:5000 -v /var/run/docker.sock:/var/run/docker.sock python:${TRAVIS_PYTHON_VERSION}-stretch /moto/travis_moto_server.sh &
-    fi
-    travis_retry pip install boto==2.45.0
-    travis_retry pip install boto3
-    travis_retry pip install dist/moto*.gz
-    travis_retry pip install coveralls==1.1
-    travis_retry pip install -r requirements-dev.txt
+  if [ "$TEST_SERVER_MODE" = "true" ]; then
+    docker run --rm -t --name motoserver -e TEST_SERVER_MODE=true -e AWS_SECRET_ACCESS_KEY=server_secret -e AWS_ACCESS_KEY_ID=server_key -v `pwd`:/moto -p 5000:5000 -v /var/run/docker.sock:/var/run/docker.sock python:${TRAVIS_PYTHON_VERSION}-stretch /moto/travis_moto_server.sh &
+  fi
+  travis_retry pip install boto==2.45.0
+  travis_retry pip install boto3
+  travis_retry pip install dist/moto*.gz
+  travis_retry pip install coveralls==1.1
+  travis_retry pip install -r requirements-dev.txt
 
-    if [ "$TEST_SERVER_MODE" = "true" ]; then
-      python wait_for.py
-    fi
+  if [ "$TEST_SERVER_MODE" = "true" ]; then
+    python wait_for.py
+  fi
 script:
-  - make test
+- make test
 after_success:
-  - coveralls
+- coveralls
+before_deploy:
+- git checkout $TRAVIS_BRANCH
+- python update_version_from_git.py
+deploy:
+  - provider: pypi
+    distributions: sdist bdist_wheel
+    user: spulec
+    password:
+      secure: NxnPylnTfekJmGyoufCw0lMoYRskSMJzvAIyAlJJVYKwEhmiCPOrdy5qV8i8mRZ1AkUsqU3jBZ/PD56n96clHW0E3d080UleRDj6JpyALVdeLfMqZl9kLmZ8bqakWzYq3VSJKw2zGP/L4tPGf8wTK1SUv9yl/YNDsBdCkjDverw=
+    on:
+      branch:
+      - master
+    skip_cleanup: true
+  - provider: pypi
+    distributions: sdist bdist_wheel
+    user: spulec
+    password:
+      secure: NxnPylnTfekJmGyoufCw0lMoYRskSMJzvAIyAlJJVYKwEhmiCPOrdy5qV8i8mRZ1AkUsqU3jBZ/PD56n96clHW0E3d080UleRDj6JpyALVdeLfMqZl9kLmZ8bqakWzYq3VSJKw2zGP/L4tPGf8wTK1SUv9yl/YNDsBdCkjDverw=
+    on:
+      tags: true

README.md

@@ -318,3 +318,11 @@ boto3.resource(
 ```console
 $ pip install moto
 ```
+
+## Releases
+
+Releases are done from travisci. Fairly closely following this:
+https://docs.travis-ci.com/user/deployment/pypi/
+
+- Commits to `master` branch do a dev deploy to pypi.
+- Commits to a tag do a real deploy to pypi.

setup.py

@@ -18,6 +18,15 @@ def read(*parts):
         return fp.read()
 
 
+def get_version():
+    version_file = read('moto', '__init__.py')
+    version_match = re.search(r'^__version__ = [\'"]([^\'"]*)[\'"]',
+                              version_file, re.MULTILINE)
+    if version_match:
+        return version_match.group(1)
+    raise RuntimeError('Unable to find version string.')
+
+
 install_requires = [
     "Jinja2>=2.10.1",
     "boto>=2.36.0",
@@ -57,7 +66,7 @@ else:
 
 setup(
     name='moto',
-    version='1.3.8',
+    version=get_version(),
     description='A library that allows your python tests to easily'
                 ' mock out the boto library',
     long_description=read('README.md'),

update_version_from_git.py

@@ -0,0 +1,119 @@
+"""
+Adapted from https://github.com/pygame/pygameweb/blob/master/pygameweb/builds/update_version_from_git.py
+
+For updating the version from git.
+__init__.py contains a __version__ field.
+Update that.
+If we are on master, we want to update the version as a pre-release.
+git describe --tags
+With these:
+    __init__.py
+        __version__= '0.0.2'
+    git describe --tags
+        0.0.1-22-g729a5ae
+We want this:
+    __init__.py
+        __version__= '0.0.2.dev22.g729a5ae'
+Get the branch/tag name with this.
+    git symbolic-ref -q --short HEAD || git describe --tags --exact-match
+"""
+
+import io
+import os
+import re
+import subprocess
+
+
+def migrate_source_attribute(attr, to_this, target_file, regex):
+    """Updates __magic__ attributes in the source file"""
+    change_this = re.compile(regex, re.S)
+    new_file = []
+    found = False
+
+    with open(target_file, 'r') as fp:
+        lines = fp.readlines()
+
+    for line in lines:
+        if line.startswith(attr):
+            found = True
+            line = re.sub(change_this, to_this, line)
+        new_file.append(line)
+
+    if found:
+        with open(target_file, 'w') as fp:
+            fp.writelines(new_file)
+
+def migrate_version(target_file, new_version):
+    """Updates __version__ in the source file"""
+    regex = r"['\"](.*)['\"]"
+    migrate_source_attribute('__version__', f"'{new_version}'", target_file, regex)
+
+
+def is_master_branch():
+    cmd = ('git rev-parse --abbrev-ref HEAD')
+    tag_branch = subprocess.check_output(cmd, shell=True)
+    return tag_branch in [b'master\n']
+
+def git_tag_name():
+    cmd = ('git describe --tags')
+    tag_branch = subprocess.check_output(cmd, shell=True)
+    tag_branch = tag_branch.decode().strip()
+    return tag_branch
+
+def get_git_version_info():
+    cmd = 'git describe --tags'
+    ver_str = subprocess.check_output(cmd, shell=True)
+    ver, commits_since, githash = ver_str.decode().strip().split('-')
+    return ver, commits_since, githash
+
+def prerelease_version():
+    """ return what the prerelease version should be.
+    https://packaging.python.org/tutorials/distributing-packages/#pre-release-versioning
+    0.0.2.dev22
+    """
+    ver, commits_since, githash = get_git_version_info()
+    initpy_ver = get_version()
+
+    assert len(initpy_ver.split('.')) in [3, 4], 'moto/__init__.py version should be like 0.0.2 or 0.0.2.dev'
+    assert initpy_ver > ver, 'the moto/__init__.py version should be newer than the last tagged release.'
+    # return f'{initpy_ver}.dev{commits_since}+git.{commits_since}.{githash}'
+    return f'{initpy_ver}{commits_since}'
+
+def read(*parts):
+    """ Reads in file from *parts.
+    """
+    try:
+        return io.open(os.path.join(*parts), 'r', encoding='utf-8').read()
+    except IOError:
+        return ''
+
+def get_version():
+    """ Returns version from moto/__init__.py
+    """
+    version_file = read('moto', '__init__.py')
+    version_match = re.search(r'^__version__ = [\'"]([^\'"]*)[\'"]',
+                              version_file, re.MULTILINE)
+    if version_match:
+        return version_match.group(1)
+    raise RuntimeError('Unable to find version string.')
+
+
+def release_version_correct():
+    """Makes sure the:
+    - prerelease verion for master is correct.
+    - release version is correct for tags.
+    """
+    if is_master_branch():
+        # update for a pre release version.
+        initpy = os.path.abspath("moto/__init__.py")
+
+        new_version = prerelease_version()
+        print(f'updating version in __init__.py to {new_version}')
+        migrate_version(initpy, new_version)
+    else:
+        # check that we are a tag with the same version as in __init__.py
+        assert get_version() == git_tag_name(), 'git tag/branch name not the same as moto/__init__.py __verion__'
+
+
+if __name__ == '__main__':
+    release_version_correct()