Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bumps version to 0.2.1 and improve README #10

Merged
merged 3 commits into from
Jan 18, 2024
Merged

Bumps version to 0.2.1 and improve README #10

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b7544bf
NO-JIRA: Bump version to 0.2.1
PaulVanSchayck Jan 16, 2024
cb441b4
NO-JIRA: Add note about linting, typing and related packages.
PaulVanSchayck Jan 16, 2024
c76a014
Update README.md
PaulVanSchayck Jan 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 18 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ This repository contains the coveragejson-pydantic Python package. It provides [
pip install covjson-pydantic
```

Or install from source:
Or you can install directly from source:

```shell
pip install git+https://github.com/KNMI/covjson-pydantic.git
Expand Down Expand Up @@ -106,7 +106,7 @@ Will print

## Contributing

Make an editable install from within the repository root
Make an editable installation from within the repository root

```shell
pip install -e '.[test]'
Expand All @@ -118,9 +118,24 @@ pip install -e '.[test]'
pytest tests/
```

### Linting and typing

Linting and typing (mypy) is doing using [pre-commit](https://pre-commit.com) hooks.

```shell
pip install pre-commit
pre-commit install
pre-commit run
```

## Related packages

* [edr-pydantic](https://github.com/KNMI/edr-pydantic) - Pydantic data models for the Environmental Data Retrieval (EDR) API
* [geojson-pydantic](https://github.com/developmentseed/geojson-pydantic) - Pydantic data models for the GeoJSON spec

## Real world usage

This library is used to build an Environmental Data Retrieval (EDR) API, serving automatic weather data station data from the KNMI. See the [KNMI Data Platform](https://developer.dataplatform.knmi.nl/edr-api).
This library is used to build an OGC Environmental Data Retrieval (EDR) API, serving automatic weather data station data from The Royal Netherlands Meteorological Institute (KNMI). See the [KNMI Data Platform EDR API](https://developer.dataplatform.knmi.nl/edr-api).

## TODOs
Help is wanted in the following areas to fully implement the CovJSON spec:
Expand All @@ -132,11 +147,3 @@ Help is wanted in the following areas to fully implement the CovJSON spec:
## License

Apache License, Version 2.0

## Authors

Members of the KNMI Data Platform team. Reachable at [email protected].

## Copyright

Koninklijk Nederlands Meteorologisch Instituut (KNMI)
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ classifiers = [
"Topic :: Scientific/Engineering :: GIS",
"Typing :: Typed",
]
version = "0.2.0"
version = "0.2.1"
dependencies = ["pydantic>=2.3,<3"]

[project.optional-dependencies]
Expand Down