From 4d48b995b30ce01826ebaa0ebac49ecb3f362f01 Mon Sep 17 00:00:00 2001 From: Anderson Banihirwe Date: Tue, 28 Dec 2021 15:26:26 -0700 Subject: [PATCH 1/2] Remove linting workflow --- .github/workflows/linting.yaml | 31 ------------------------------- 1 file changed, 31 deletions(-) delete mode 100644 .github/workflows/linting.yaml diff --git a/.github/workflows/linting.yaml b/.github/workflows/linting.yaml deleted file mode 100644 index 597d756..0000000 --- a/.github/workflows/linting.yaml +++ /dev/null @@ -1,31 +0,0 @@ -name: linting - -on: - push: - pull_request: - workflow_dispatch: - -jobs: - pre-job: - runs-on: ubuntu-latest - outputs: - should_skip: ${{ steps.skip_check.outputs.should_skip }} - steps: - - id: skip_check - uses: fkirc/skip-duplicate-actions@master - with: - concurrent_skipping: 'same_content' - skip_after_successful_duplicate: 'false' - do_not_skip: '["workflow_dispatch", "schedule"]' - linting: - needs: pre-job - runs-on: ubuntu-latest - if: ${{ needs.pre-job.outputs.should_skip != 'true' }} - steps: - - name: Cancel Previous Runs - uses: styfle/cancel-workflow-action@0.9.1 - with: - access_token: ${{ github.token }} - - uses: actions/checkout@v2 - - uses: actions/setup-python@v2 - - uses: pre-commit/action@v2.0.3 From 8306b49f95baa61f8e2143d1c75bbf24bd6ead0f Mon Sep 17 00:00:00 2001 From: Anderson Banihirwe Date: Tue, 28 Dec 2021 15:29:12 -0700 Subject: [PATCH 2/2] Update README --- README.md | 43 +++++++++++-------------------------------- 1 file changed, 11 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index a653b74..98c8d1f 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,18 @@ # ecgtools -- [ecgtools](#ecgtools) - - [Badges](#badges) +| CI | [![GitHub Workflow Status][github-ci-badge]][github-ci-link] [![Code Coverage Status][codecov-badge]][codecov-link] | +| :---------- | :-----------------------------------------------------------------------------------------------------------------: | +| **Docs** | [![Documentation Status][rtd-badge]][rtd-link] | +| **Package** | [![Conda][conda-badge]][conda-link] [![PyPI][pypi-badge]][pypi-link] | +| **License** | [![License][license-badge]][repo-link] | -## Badges +## Motivation + +The critical requirement for using [`intake-esm`](https://github.com/intake/intake-esm) is having a data catalog. This package enables you build data catalogs to be read in by [`intake-esm`](https://github.com/intake/intake-esm), which enables a user to easily search, discover, and access datasets they are interested in using. -| CI | [![GitHub Workflow Status][github-ci-badge]][github-ci-link] [![GitHub Workflow Status][github-lint-badge]][github-lint-link] [![Code Coverage Status][codecov-badge]][codecov-link] | -| :---------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | -| **Docs** | [![Documentation Status][rtd-badge]][rtd-link] | -| **Package** | [![Conda][conda-badge]][conda-link] [![PyPI][pypi-badge]][pypi-link] | -| **License** | [![License][license-badge]][repo-link] | +See [documentation](https://ecgtools.readthedocs.io) for more information. - - [github-ci-badge]: https://img.shields.io/github/workflow/status/NCAR/ecgtools/CI?label=CI&logo=github&style=for-the-badge -[github-lint-badge]: https://img.shields.io/github/workflow/status/NCAR/ecgtools/linting?label=linting&logo=github&style=for-the-badge [github-ci-link]: https://github.com/NCAR/ecgtools/actions?query=workflow%3ACI -[github-lint-link]: https://github.com/NCAR/ecgtools/actions?query=workflow%3Alinting [codecov-badge]: https://img.shields.io/codecov/c/github/NCAR/ecgtools.svg?logo=codecov&style=for-the-badge [codecov-link]: https://codecov.io/gh/NCAR/ecgtools [rtd-badge]: https://img.shields.io/readthedocs/ecgtools/latest.svg?style=for-the-badge @@ -41,21 +38,3 @@ See [documentation](https://ecgtools.readthedocs.io) for more information. --> [conda-link]: https://anaconda.org/conda-forge/ecgtools [license-badge]: https://img.shields.io/github/license/NCAR/ecgtools?style=for-the-badge [repo-link]: https://github.com/NCAR/ecgtools - -## Motivation - -Similar to [`intake-esm`](https://github.com/intake/intake-esm), this package helps with finding, investigating, and loading data. The critical requirement for using [`intake-esm`](https://github.com/intake/intake-esm) is having a data catalog. This package enables you build data catalogs to be read in by [`intake-esm`](https://github.com/intake/intake-esm), which enables a user to easily search, discover, and access datasets they are interested in using. - -## Installation - -ecgtools can be installed from PyPI with pip: - -```bash -python -m pip install ecgtools -``` - -It is also available from conda-forge for conda installations: - -```bash -conda install -c conda-forge ecgtools -```