Giter Club home page Giter Club logo

hkosharp's Introduction


C# Library of Hong Kong Observatory Open Data API

Build Status codecov Nuget version GitHub latest version License

What is HKOSharp?

HKOSharp is a C# library which allows you to access the Hong Kong Observatory Open Data API without handling bunches of Http requests, responses or JSON.

Todo list

  1. Update documentation for a recent rewrite.
  2. Translate document into Chinese Traditional and Chinese Simplified.
  3. Finish Weather class.
  4. Move from CircleCI to Travis CI. (Succeesfully moved to GitHub Workflow)
  5. Increase Code Coverage

Build

To build the project, you need to:

  1. Clone the repo to your machine.
  2. Open the .sln file with your favourite IDE.
  3. That's it!

Installation

To use HKOSharp in your project, there are several ways to do so:

Usage

For the full usage of HKOSharp, you should check HKOSharp Documentations.

WARNING: Library were rewritten recently and documentation may not be up-to-date.

Here are some examples of usages of HKOSharp:

// Imports namespace
using HKOSharp.LibHKOSharp;
// Gets today's Local Weather Forecast
var localForecast = Weather.GetLocalForecast(Language.English);
Console.Write("Description of today's forecast: ");
Console.Write(localForecast.ForecastDesc);
// Output:
// Description of today's forecast: Under the influence of an anticyclone aloft, the weather is ...
// Gets latest Earthquake information
var eqInfo = Earthquake.GetLatestEqInfoAsnyc(Language.TraditionalChinese);
Console.Write("Latest Earthquake Report Region: ");
Console.Write(eqInfo.Region);
// Output:
// Latest Earthquake Report Region: 班達海

Dependencies

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.