Skip to content

Commit

Permalink
docs(readme): add pypi package information to readme (#237)
Browse files Browse the repository at this point in the history
Fixes: #223
  • Loading branch information
afuetterer authored Jan 23, 2024
1 parent dc6dccf commit ada4dcf
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ now with additional features and ongoing maintenance.
| __CI__ | [![pre-commit.ci status][pre-commit-ci-badge]][pre-commit-ci-status] [![ci][ci-badge]][ci-workflow] [![coverage][coverage-badge]][ci-workflow] |
| :--- | :--- |
| __Docs__ | [![docs][docs-badge]][docs-workflow] |
| __Package__ | [![pypi-version][pypi-version-badge]][pypi-url] [![pypi-python-versions][pypi-python-versions-badge]][pypi-url]|
| __Meta__ | [![OpenSSF Scorecard][scorecard-badge]][scorecard-url] [![hatch][hatch-badge]][hatch] [![ruff][ruff-badge]][ruff] [![mypy][mypy-badge]][mypy] [![License][license-badge]][license] |

oaipmh-scythe is a lightweight [OAI-PMH](http://www.openarchives.org/OAI/openarchivesprotocol.html)
Expand Down Expand Up @@ -38,6 +39,8 @@ oaipmh-scythe is built with:

## Installation

You can install oaipmh-scythe via pip from [PyPI][pypi-url]:

```console
python -m pip install oaipmh-scythe
```
Expand Down Expand Up @@ -71,7 +74,6 @@ This is a fork of [sickle](https://github.com/mloesch/sickle) which was original
oaipmh-scythe is distributed under the terms of the [BSD license](https://spdx.org/licenses/BSD-3-Clause.html).

<!-- Markdown links -->
<!-- dynamic -->
[ci-workflow]: https://github.com/afuetterer/oaipmh-scythe/actions/workflows/main.yml
[ci-badge]: https://github.com/afuetterer/oaipmh-scythe/actions/workflows/main.yml/badge.svg
[coverage-badge]: https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/afuetterer/fcb87d45f4d7defdfeffa65eb1d65f63/raw/coverage-badge.json
Expand All @@ -82,7 +84,10 @@ oaipmh-scythe is distributed under the terms of the [BSD license](https://spdx.o
[docs-badge]: https://github.com/afuetterer/oaipmh-scythe/actions/workflows/docs.yml/badge.svg
[scorecard-url]: https://securityscorecards.dev/viewer/?uri=github.com/afuetterer/oaipmh-scythe
[scorecard-badge]: https://api.securityscorecards.dev/projects/github.com/afuetterer/oaipmh-scythe/badge
<!-- static -->
[pypi-url]: https://pypi.org/project/oaipmh-scythe/
[pypi-version-badge]: https://img.shields.io/pypi/v/oaipmh-scythe.svg?logo=pypi&label=PyPI
[pypi-downloads-badge]: https://img.shields.io/pypi/dm/oaipmh-scythe.svg?color=blue&label=Downloads&logo=pypi
[pypi-python-versions-badge]: https://img.shields.io/pypi/pyversions/oaipmh-scythe.svg?logo=python&label=Python
[license]: https://spdx.org/licenses/BSD-3-Clause.html
[license-badge]: https://img.shields.io/badge/License-BSD_3--Clause-blue.svg
[hatch]: https://github.com/pypa/hatch
Expand All @@ -91,5 +96,3 @@ oaipmh-scythe is distributed under the terms of the [BSD license](https://spdx.o
[ruff-badge]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json
[mypy]: https://mypy-lang.org
[mypy-badge]: https://img.shields.io/badge/types-mypy-blue.svg
[test-pypi]: https://test.pypi.org/
[pip]: https://pip.pypa.io/

0 comments on commit ada4dcf

Please sign in to comment.