MichelMichels.BpostSharp 1.1.0

BpostSharp ✉️

This projects is a C# wrapper library to obtain Belgian city data from bpost (Belgian national mail service).

<details> <summary>Table of Contents</summary>

• BpostSharp ✉️
  • Prerequisites
  • Building
  • Installation
  • Getting started
    • Example code
  • Code explanation
  • Credits

</details>

Prerequisites

• .NET 8.0

Building

Use Visual Studio 2022 to build the project.

Installation

Get the NuGet packages from nuget.org or search for MichelMichels.BpostSharp in the GUI package manager in Visual Studio.

You can also use the cli of the package manager with one of following commands:

Install-Package MichelMichels.BpostSharp.Excel
Install-Package MichelMichels.BpostSharp.Web

Above commands will also add a dependency to MichelMichels.BpostSharp. This nuget package contains the core code.

Getting started

There are 2 versions of BpostSharp:

These 2 versions have following dependency:

To use the excel version, use any version of the files at the official bpost website. To use the web version, grab one of the HTML versions on the same page.

Example code

Creating a web instance:

ICacheBuilder<CityData> webCacheBuilder = new WebCacheBuilder(BpostWebConstants.DutchEndpoint);
ICityDataService cityDataService = new BelgianCityDataService(webCacheBuilder);

Creating an excel instance:

ICacheBuilder<CityData> webCacheBuilder = new ExcelCacheBuilder("excel-from-bpost.xls");
ICityDataService cityDataService = new BelgianCityDataService(webCacheBuilder);

Querying data:

// Querying by postal code
List<CityData> data = await cityDataService.GetByPostalCode("9000");

// Querying by city name
List<CityData> data = await cityDataService.GetByCityName("Gent");

Code explanation

The querying uses StartsWith(...) and ignores casing.

Data is saved into cache after executing Build() on the ICacheBuilder or after first query, whichever comes earlier. You can clear the cache with Clear().

Credits

Written by Michel Michels.