Merge pull request #101 from sfinkens/feature-release

Prepare for next release

Author: sfinkens

.gitignore

@@ -7,3 +7,4 @@ dist
 pygac.egg-info
 etc/*.cfg
 gapfilled_tles/
+pygac/version.py

LICENSE renamed to LICENSE.txt

@@ -1,5 +1,6 @@
 include etc/*
-include testdata/*
 include gapfilled_tles/*
-include pygac/*.pyx
 include bin/pygac-*
+include LICENSE.txt
+include README.md
+include pygac/version.py

MANIFEST.in

@@ -7,25 +7,37 @@
    values.  To get the previous version run `git tag` and select the most
    recent with highest version number.
 
-```
-loghub pytroll/pygac -u <github username> -st v<previous version> -plg bug "Bugs fixed" -plg enhancement "Features added" -plg documentation "Documentation changes" -plg backwards-incompatibility "Backwards incompatible changes"
-```
+   ```
+   loghub pytroll/pygac -u <github username> -st v<previous version> -plg bug "Bugs fixed" -plg enhancement "Features added" -plg documentation "Documentation changes" -plg backwards-incompatibility "Backwards incompatible changes"
+   ```
 
-This command will create a CHANGELOG.temp file which need to be added
-to the top of the CHANGLOG.md file.  The same content is also printed
-to terminal, so that can be copy-pasted, too.  Remember to update also
-the version number to the same given in step 5. Don't forget to commit
-CHANGELOG.md!
+   This command will create a CHANGELOG.temp file which need to be added
+   to the top of the CHANGLOG.md file.  The same content is also printed
+   to terminal, so that can be copy-pasted, too.  Remember to update also
+   the version number to the same given in step 5. Don't forget to commit
+   CHANGELOG.md!
 
-5. Bump up the version with
+5. Create a tag with the new version number, starting with a 'v', eg:
 
-```
-bumpversion <level>
-```
+   ```
+   git tag -a v<new version> -m "Version <new version>"
+   ```
 
-where level is one of `major`, `minor`, or `patch`.
+   For example if the previous tag was `v0.9.0` and the new release is a
+   patch release, do:
 
+   ```
+   git tag -a v0.9.1 -m "Version 0.9.1"
+   ```
+
+   See [semver.org](http://semver.org/) on how to write a version number.
 
 6. push changes to github `git push --follow-tags`
-7. Verify travis tests passed
-8. Deploy sdist (and wheel) to PyPI
+7. Verify github action unittests passed.
+8. Create a "Release" on GitHub by going to
+   https://github.com/pytroll/pygac/releases and clicking "Draft a new release".
+   On the next page enter the newly created tag in the "Tag version" field,
+   "Version X.Y.Z" in the "Release title" field, and paste the markdown from
+   the changelog (the portion under the version section header) in the
+   "Describe this release" box. Finally click "Publish release".
+9. Verify the GitHub actions for deployment succeed and the release is on PyPI.

RELEASING.md

@@ -21,8 +21,15 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+try:
+    from pygac.version import version as __version__  # noqa
+except ModuleNotFoundError:
+    raise ModuleNotFoundError(
+        "No module named pygac.version. This could mean "
+        "you didn't install 'pygac' properly. Try reinstalling ('pip "
+        "install').")
+
 import logging
-from pygac.version import __version__  # noqa
 from pygac.configuration import get_config, read_config_file  # noqa
 from pygac.runner import get_reader_class, process_file  # noqa
 

pygac/__init__.py

@@ -0,0 +1,6 @@
+[build-system]
+requires = ["setuptools>=45", "wheel", "setuptools_scm[toml]>=6.2", 'setuptools_scm_git_archive']
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools_scm]
+write_to = "pygac/version.py"

pygac/version.py

@@ -1,2 +1,7 @@
+[options]
+setup_requires =
+    setuptools_scm
+    setuptools_scm_git_archive
+
 [flake8]
 max-line-length = 120

pyproject.toml

@@ -21,20 +21,13 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 """The setup module."""
 
-try:
-    with open("./README", "r") as fd:
-        long_description = fd.read()
-except IOError:
-    long_description = ""
-
-
 from setuptools import setup
-import imp
 import sys
 import os
 
 if __name__ == '__main__':
-    version = imp.load_source('pygac.version', 'pygac/version.py')
+    with open("README.md", "r") as fd:
+        long_description = fd.read()
 
     requirements = ['docutils>=0.3',
                     'numpy>=1.8.0',
@@ -52,10 +45,9 @@
         requirements.append('python-dateutil>=2.8.0')
 
     setup(name='pygac',
-          version=version.__version__,
           description='NOAA AVHRR GAC/LAC reader and calibration',
-          author='Abhay Devasthale, Martin Raspaud',
-          author_email='martin.raspaud@smhi.se',
+          author='The Pytroll Team',
+          author_email='pytroll@googlegroups.com',
           classifiers=["Development Status :: 4 - Beta",
                        "Intended Audience :: Science/Research",
                        "License :: OSI Approved :: GNU General Public License v3 " +
@@ -65,6 +57,7 @@
                        "Topic :: Scientific/Engineering"],
           url="https://github.com/pytroll/pygac",
           long_description=long_description,
+          long_description_content_type='text/markdown',
           license='GPLv3',
 
           packages=['pygac'],
@@ -77,8 +70,6 @@
           scripts=[os.path.join('bin', item) for item in os.listdir('bin')],
           data_files=[('etc', ['etc/pygac.cfg.template']),
                       ('gapfilled_tles', ['gapfilled_tles/TLE_noaa16.txt'])],
-          test_suite="pygac.tests.suite",
-          tests_require=[],
           python_requires='>=3.6',
           zip_safe=False
           )