Metadata-Version: 2.4
Name: bikenetlib
Version: 0.0.0
Summary: BikeNetKit Python core utility package
Author: Manuel Knepper, Anastassia Vybornova, Michael Szell
Maintainer-email: Michael Szell <michael@szell.net>
License-Expression: AGPL-3.0-or-later
Project-URL: Repository, https://github.com/BikeNetKit/BikeNetLib
Project-URL: Issues, https://github.com/BikeNetKit/BikeNetLib/issues
Keywords: Bicycle network planning,Networks,OpenStreetMap,Urban Planning,Urban Mobility
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Natural Language :: English
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: geopandas>=0.14
Requires-Dist: matplotlib
Requires-Dist: osmnx>=1.9.4
Requires-Dist: geojson
Requires-Dist: tqdm
Requires-Dist: pip
Requires-Dist: momepy
Requires-Dist: opencv-python
Requires-Dist: python-slugify
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Provides-Extra: doc
Requires-Dist: sphinx; extra == "doc"
Requires-Dist: momepy; extra == "doc"
Dynamic: license-file

# Bike Net Kit / Bike Net Lib

[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
[![Test](https://github.com/BikeNetKit/BikeNetLib/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/BikeNetKit/BikeNetLib/actions/workflows/test.yml)

The Python package `bikenetlib` is BikeNetKit's Python core utility package. It offers utilities for working with bicycle networks and forms the core of many upstream packages
in the [BikeNetKit family](https://github.com/BikeNetKit), like [GrowBikeNet](https://github.com/BikeNetKit/GrowBikeNet), [FixBikeNet](https://github.com/BikeNetKit/FixBikeNet), or [LinkBikeNet](https://github.com/BikeNetKit/LinkBikeNet).

There are three building blocks:

- `bikenetlib.io` – Input and output
- `bikenetlib.utils` – Utilities
- `bikenetlib.viz` – Visualization

BikeNetLib mainly builds on [OSMnx](https://github.com/gboeing/osmnx) and [GeoPandas](https://github.com/geopandas/geopandas).

## Installation

```
pip install bikenetlib
```

## Credits

<!--Please cite as:
>AUTHOR1, AUTHOR2, and AUTHOR3, PROJECTNAME, JOURNAL (YYYY), DOIURL
-->

Development of BikeNetKit/BikeNetLib was supported by the Danish Innovation Fund (Innovationsfonden).
