https://github.com/andmos/BikeshareClient

C# client for General Bikeshare Feed Specification (GBFS)
https://github.com/andmos/BikeshareClient

bikeshare bikeshare-systems gbfs netstandard

Last synced: about 2 months ago
JSON representation

C# client for General Bikeshare Feed Specification (GBFS)

• Host: GitHub
• URL: https://github.com/andmos/BikeshareClient
• Owner: andmos
• License: mit
• Created: 2018-06-04T12:37:55.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-01-08T04:24:21.000Z (12 months ago)
• Last Synced: 2024-10-29T19:48:52.138Z (2 months ago)
• Topics: bikeshare, bikeshare-systems, gbfs, netstandard
• Language: C#
• Size: 257 KB
• Stars: 5
• Watchers: 4
• Forks: 1
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• open-sustainable-technology - BikeshareClient - Dotnet library for integrating with GBFS bikeshare systems. (Consumption / Mobility and Transportation)

README

        
BikeshareClient

===

Dotnet client for the General Bikeshare Feed Specification ([GBFS](https://github.com/NABSA/gbfs)).

Mainly used against [Urban Infrastructure Partner](https://urbansharing.com/), with [Trondheim City Bike](https://trondheimbysykkel.no/en/open-data) and [Bergen City Bike](https://bergenbysykkel.no/en/apne-data).

For all available GBFS systems, [see the system overview from the GBFS project](https://github.com/NABSA/gbfs/blob/master/systems.csv).

Supports the required fields in the GBFS standard for now.

## Basic Usage

```csharp

// Create the client from a GBFS API URL.

IBikeshareClient client = new Client("http://gbfs.urbansharing.com/trondheim/gbfs.json");

// Or with an existing HTTPClient

IBikeshareClient client = new Client("http://gbfs.urbansharing.com/trondheim/gbfs.json", httpClient);

// All available stations, containing name, id, lat, long, address and capacity

var stations = await client.GetStationsAsync();

// All stations status, containing number of bikes and docks available, is renting, is returning etc.

var statuses = await client.GetStationsStatusAsync();

```

A simple [dotnet-script](https://github.com/filipw/dotnet-script) test script for the client can be seen [here](https://github.com/andmos/BikeshareClient/blob/master/src/TestScript/main.csx).

## Microsoft.Extensions.DependencyInjection integration

`BikeshareClient` can be registered to `IServiceCollection` by referencing the `BikeshareClient.DependencyInjection` [NuGet package](https://www.nuget.org/packages/BikeshareClient.DependencyInjection/):

```csharp

using BikeshareClient.DependencyInjection;

using Microsoft.Extensions.DependencyInjection;

services.AddBikeshareClient("http://gbfs.urbansharing.com/trondheim/gbfs.json");

```

## Build and testscript

Simple build:

```bash

docker run --rm -it -v $(pwd):/app mcr.microsoft.com/dotnet/sdk:7.0 dotnet pack app/src/BikeshareClient -o /app

```

Run test script:

```bash

docker run --rm -it -v $(pwd)/src/TestScript/:/scripts  andmos/dotnet-script main.csx "Skansen"

```

[![CI / CD](https://github.com/andmos/BikeshareClient/actions/workflows/ci.yaml/badge.svg?branch=master)](https://github.com/andmos/BikeshareClient/actions/workflows/ci.yaml)

[![codecov](https://codecov.io/gh/andmos/BikeshareClient/branch/master/graph/badge.svg)](https://codecov.io/gh/andmos/BikeshareClient)

[![NuGet BikeshareClient](https://img.shields.io/nuget/v/BikeshareClient.svg)](https://www.nuget.org/packages/BikeshareClient/)

[![NuGet BikeshareClient.DependencyInjection](https://img.shields.io/nuget/v/BikeshareClient.DependencyInjection.svg)](https://www.nuget.org/packages/BikeshareClient.DependencyInjection/)

[![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=andmos/BikeshareClient)](https://dependabot.com)

>[GBFS](https://github.com/NABSA/gbfs) is a standard backed by the North American Bike Share Association ([NABSA](https://nabsa.net/)).