Metadata-Version: 2.1
Name: pyhaversine
Version: 0.0.3
Summary: Haversine function using pybind11
Home-page: https://github.com/luk-f/pyhaversine
Author: Lucas Foulon
Author-email: lucas.foulon@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: test
Requires-Dist: pytest ; extra == 'test'

pyHaversine
==============

[![PyPI](https://github.com/luk-f/pyhaversine/actions/workflows/pip.yml/badge.svg)](https://github.com/luk-f/pyhaversine/actions/workflows/pip.yml)

An simple project built with [pybind11](https://github.com/pybind/pybind11).
This requires Python 3.6+; for older versions of Python, check the commit
history.

Installation
------------

 - Use `pip install pyhaversine` directly

Or, manually:

 - clone this repository
 - `pip install ./pyhaversine`


Building the documentation (no available)
--------------------------

Documentation for the example project is generated using Sphinx. Sphinx has the
ability to automatically inspect the signatures and documentation strings in
the extension module to generate beautiful documentation in a variety formats.
The following command generates HTML-based reference documentation; for other
formats please refer to the Sphinx manual:

 - `cd pyhaversine/docs`
 - `make html`

License
-------

pybind11 is provided under a BSD-style license that can be found in the LICENSE
file. By using, distributing, or contributing to this project, you agree to the
terms and conditions of this license.

Test call
---------

```python
import pyhaversine
pyhaversine.haversine((1.0, 2.0), (3.0, 4.0))
```

[`cibuildwheel`]:          https://cibuildwheel.readthedocs.io


