Switch from versioneer to setuptools-scm (#695)

Replace versioneer added in 3683f37
with the more modern [setuptools-scm](https://github.com/pypa/setuptools_scm).

* Get 8 char short hash to store in __commit__
* Just use pkg_resources.get_distribution to obtain version string
* Just put setup_requires in setup.py
* Let workflows be based on setuptools-scm instead of versioneer
* Don't write to _version.py file

Author: weiji14

.codeclimate.yml

@@ -29,8 +29,6 @@ plugins:
         enabled: false
 
 exclude_paths:
-- "versioneer.py"
-- "pygmt/_version.py"
 - "doc/**/*"
 - "pygmt/tests/baseline/*"
 - "pygmt/tests/data/*"

.gitattributes

@@ -64,9 +64,9 @@ jobs:
 
       # Checkout current git repository
       - name: Checkout
-        uses: actions/[email protected].1
+        uses: actions/[email protected].4
         with:
-          # fecth all history so that versioneer works
+          # fecth all history so that setuptools-scm works
           fetch-depth: 0
 
       # Setup Miniconda

.github/workflows/ci_tests.yaml

@@ -39,9 +39,9 @@ jobs:
 
       # Checkout current git repository
       - name: Checkout
-        uses: actions/[email protected].1
+        uses: actions/[email protected].4
         with:
-          # fecth all history so that versioneer works
+          # fecth all history so that setuptools-scm works
           fetch-depth: 0
 
       # Setup Miniconda

.github/workflows/ci_tests_dev.yaml

@@ -24,7 +24,7 @@ jobs:
     - name: Checkout
       uses: actions/[email protected]
       with:
-        # fecth all history so that versioneer works
+        # fecth all history so that setuptools-scm works
         fetch-depth: 0
 
     - name: Set up Python
@@ -37,13 +37,12 @@ jobs:
 
     - name: Fix up version string
       run: |
-        # Change the versioneer format to "pre" so that the commit hash isn't
-        # included (PyPI doesn't allow it). Can't do this permanently because
-        # we rely on the hash to tell the tests that this is a local version
-        # instead of a published version.
+        # Change setuptools-scm local_scheme to "no-local-version" so the
+        # local part of the version isn't included, making the version string
+        # compatible with PyPI.
         #
         # The step is only necessary for testing purpose
-        sed --in-place "s/pep440/pep440-pre/g" setup.cfg
+        sed --in-place "s/node-and-date/no-local-version/g" setup.py
 
     - name: Build source and wheel distributions
       run: |

.github/workflows/publish-to-pypi.yml

@@ -103,8 +103,8 @@ see https://zeit.co/docs/v2/build-step/?query=package.json#defining-a-build-scri
 
 We try to automate the release process as much as possible.
 Travis handles publishing new releases to PyPI and updating the documentation.
-The version number is set automatically using versioneer based information it gets from
-git.
+The version number is set automatically using setuptools_scm based information
+obtained from git.
 There are a few steps that still must be done manually, though.
 
 ### Updating the changelog

MAINTENANCE.md

@@ -3,7 +3,5 @@ include LICENSE.txt
 include CODE_OF_CONDUCT.md
 include CONTRIBUTING.md
 include AUTHORS.md
-include versioneer.py
-include pygmt/_version.py
 recursive-include pygmt/tests/data *
 recursive-include pygmt/tests/baseline *

MANIFEST.in

@@ -132,7 +132,7 @@
 html_theme_options = {}
 repository = "GenericMappingTools/pygmt"
 repository_url = "https://github.com/GenericMappingTools/pygmt"
-commit_link = f'<a href="{repository_url}/commit/{ __commit__ }">{ __commit__[:7] }</a>'
+commit_link = f'<a href="{repository_url}/commit/{ __commit__ }">{ __commit__[:8] }</a>'
 html_context = {
     "menu_links": [
         (

doc/conf.py

@@ -9,7 +9,7 @@
 
 import atexit as _atexit
 
-from ._version import get_versions as _get_versions
+from pkg_resources import get_distribution
 
 # Import modules to make the high-level GMT Python API
 from .session_management import begin as _begin, end as _end
@@ -23,10 +23,9 @@
 from .x2sys import x2sys_init, x2sys_cross
 from . import datasets
 
-
-# Get the version number through versioneer
-__version__ = _get_versions()["version"]
-__commit__ = _get_versions()["full-revisionid"]
+# Get semantic version through setuptools-scm
+__version__ = f'v{get_distribution("pygmt").version}'  # e.g. v0.1.2.dev3+g0ab3cd78
+__commit__ = __version__.split("+g")[-1]  # 0ab3cd78
 
 # Start our global modern mode session
 _begin()