From 0b890e5d8d4c7ec237a118a2b1d09bdd9bedb34e Mon Sep 17 00:00:00 2001 From: Sandor Kertesz Date: Tue, 14 Jan 2025 20:35:30 +0000 Subject: [PATCH 1/3] Use md for README --- .github/workflows/cd-pypi.yml | 4 ++-- README.rst => README.md | 24 +++++++++++++++++------- 2 files changed, 19 insertions(+), 9 deletions(-) rename README.rst => README.md (51%) diff --git a/.github/workflows/cd-pypi.yml b/.github/workflows/cd-pypi.yml index 6104026..5771ed4 100644 --- a/.github/workflows/cd-pypi.yml +++ b/.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 diff --git a/README.rst b/README.md similarity index 51% rename from README.rst rename to README.md index 351ae31..30197bd 100644 --- a/README.rst +++ b/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 `_ reader for the BUFR format using `ecCodes `_. 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. +``` From 88bea0163a4f1e401d95a8af4c177ad586caf2cc Mon Sep 17 00:00:00 2001 From: Sandor Kertesz Date: Tue, 14 Jan 2025 22:12:46 +0000 Subject: [PATCH 2/3] Remove setup.py (#83) * Remove setup.py --- .github/workflows/ci.yml | 16 ++++++++++++---- .github/workflows/legacy-ci.yml | 4 ++-- setup.cfg | 3 --- setup.py | 13 ------------- 4 files changed, 14 insertions(+), 22 deletions(-) delete mode 100644 setup.cfg delete mode 100644 setup.py diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 85e9d15..0063a5f 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -4,13 +4,19 @@ 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: @@ -18,6 +24,9 @@ on: # 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 diff --git a/.github/workflows/legacy-ci.yml b/.github/workflows/legacy-ci.yml index 25357b5..6cdb62e 100644 --- a/.github/workflows/legacy-ci.yml +++ b/.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] diff --git a/setup.cfg b/setup.cfg deleted file mode 100644 index fe42d05..0000000 --- a/setup.cfg +++ /dev/null @@ -1,3 +0,0 @@ -[flake8] -extend-ignore = E203, W503 -max-line-length = 110 diff --git a/setup.py b/setup.py deleted file mode 100644 index f147c9a..0000000 --- a/setup.py +++ /dev/null @@ -1,13 +0,0 @@ -#!/usr/bin/env python -# -# (C) Copyright 2019- ECMWF. -# -# This software is licensed under the terms of the Apache Licence Version 2.0 -# which can be obtained at http://www.apache.org/licenses/LICENSE-2.0. -# In applying this licence, ECMWF does not waive the privileges and immunities -# granted to it by virtue of its status as an intergovernmental organisation -# nor does it submit to any jurisdiction. - -import setuptools # type: ignore - -setuptools.setup() From 8b6abeffe8e72b575015eb39b427e4acf27b8d88 Mon Sep 17 00:00:00 2001 From: Sandor Kertesz Date: Tue, 14 Jan 2025 22:18:01 +0000 Subject: [PATCH 3/3] Update release notes (#84) --- docs/release_notes/version_0.12_updates.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/release_notes/version_0.12_updates.rst b/docs/release_notes/version_0.12_updates.rst index e1b127e..d7fd3ea 100644 --- a/docs/release_notes/version_0.12_updates.rst +++ b/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 `_. See details :ref:`here `.