Merge pull request #85 from ecmwf/master

Merge master into develop

.github/workflows/cd-pypi.yml

@@ -3,9 +3,9 @@ name: cd
 on:
   push:
     tags:
-    - '**'
+    - "**"
 
 jobs:
-  pypi:
+  deploy:
     uses: ecmwf-actions/reusable-workflows/.github/workflows/cd-pypi.yml@v2
     secrets: inherit

.github/workflows/ci.yml

@@ -4,20 +4,29 @@ on:
   # Trigger the workflow on push to master or develop, except tag creation
   push:
     branches:
-    - 'main'
-    - 'develop'
+    - "master"
+    - "develop"
     tags-ignore:
-    - '**'
+    - "**"
+    paths-ignore:
+    - "docs/**"
+    - "README.md"
 
   # Trigger the workflow on pull request
   pull_request:
+    paths-ignore:
+    - "docs/**"
+    - "README.md"
 
   # Trigger the workflow manually
   workflow_dispatch:
 
   # Trigger after public PR approved for CI
   pull_request_target:
     types: [labeled]
+    paths-ignore:
+    - "docs/**"
+    - "README.md"
 
 jobs:
   # Run CI including downstream packages on self-hosted runners
@@ -30,7 +39,6 @@ jobs:
       # codecov_upload: true
     secrets: inherit
 
-
   # Build downstream packages on HPC
   downstream-ci-hpc:
     name: downstream-ci-hpc

.github/workflows/legacy-ci.yml

@@ -3,13 +3,13 @@ name: legacy-ci
 on:
   push:
     branches:
-    - main
+    - master
     - develop
     tags:
     - "*"
   pull_request:
     branches:
-    - main
+    - master
     - develop
   pull_request_target:
     types: [labeled]

README.rst → README.md

@@ -1,18 +1,27 @@
-pdbufr
-======
+# pdbufr
 
-.. image:: https://img.shields.io/pypi/v/pdbufr.svg
-   :target: https://pypi.python.org/pypi/pdbufr/
+[![PyPI version fury.io](https://badge.fury.io/py/pdbufr.svg)](https://pypi.python.org/pypi/pdbufr/)
+[![PyPI pyversions](https://img.shields.io/pypi/pyversions/pdbufr.svg)](https://pypi.python.org/pypi/pdbufr/)
 
+*pdbufr* is a Python package implementing a [Pandas](https://pandas.pydata.org) reader for the BUFR format using  [ecCodes](https://confluence.ecmwf.int/display/ECC).
 
-*pdbufr* is a Python package implementing a `Pandas <https://pandas.pydata.org>`_ reader for the BUFR format using  `ecCodes <https://confluence.ecmwf.int/display/ECC>`_. It supports BUFR edition 3 and 4 files with uncompressed and compressed subsets. It works on Linux, MacOS and Windows, the ecCodes C-library is the only binary dependency. All modern versions of Python (>=3.6) and PyPy3 are supported.
+## Documentation
 
 The documentation can be found at https://pdbufr.readthedocs.io/.
 
+## Install
 
-License
-=======
+Install via `pip` with:
 
+```
+$ pip install pdbufr
+```
+
+More details, such as how to install any necessary binaries, can be found  at https://pdbufr.readthedocs.io/en/latest/install.html.
+
+## License
+
+```
 Copyright 2019- European Centre for Medium-Range Weather Forecasts (ECMWF).
 
 Licensed under the Apache License, Version 2.0 (the "License");
@@ -23,3 +32,4 @@ distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
+```

docs/release_notes/version_0.12_updates.rst

@@ -3,7 +3,7 @@ Version 0.12 Updates
 /////////////////////////
 
 
-Version 0.12.0
+Version 0.12.2
 ===============
 
 - implemented the ``WIGOS_station_id`` computed key for the `WIGOS station identifier <https://community.wmo.int/en/activity-areas/WIGOS/implementation-WIGOS/FAQ-WSI>`_. See details :ref:`here <key_wigos_station_id>`.