Giter VIP home page Giter VIP logo

uwaterlooapidotnet's Introduction

UWaterlooAPIDotNet

NuGet GitHub stars GitHub issues GitHub license

UWaterlooAPIDotNet provides an up-to-date, fully asynchronous and multi-platform wrapper for the University of Waterloo's API. The library has been built upon .NET Standard 1.3 to allow use of the wrapper on almost any platform. You can find a compatibilty chart below.

UWaterlooAPIDotNet uses NodaTime to ensure that dates and times can be compared accurately, due to .NET's native DateTime object being unable to store specific time zone information. This allows for dates and times to be converted and usable anywhere, instead of just functioning correctly in Ontario.

The library has been built to provide synchronous and asynchronous methods for every endpoint available, using the async / await pattern provided in recent versions of the .NET Framework, but will also be compatible in situations where one might find that they may not need asynchronous calls, or it is not] fully / properly supported.

UWaterlooAPIDotNet follows Semantic Versioning 2.0.0.

Compatibility

Platform Versions
.NET Standard 1.3+
.NET Core 1.0+
.NET Framework 4.6+
Xamarin (Android/iOS) 4.1.2+ (VS Plugin) / 6.0.2+ (Studio)
Mono (Linux/OSX) 4.6.0+
Universal Windows Platform 10.0+

Dependencies

Usage

To make use of UWaterlooAPIDotNet, you can install it in a number of ways.

  1. Clone this repository and compile yourself. This is for those who are interested in bleeding-edge features, however this is not recommended for production use.
  2. Download the available .nupkg files from the Releases tab of this repository. This is recommended for those who require debug symbols and packages for testing purposes. For those interested only in release builds:
  3. Install the latest version through NuGet, via Install-Package UWaterlooAPIDotNet.

Contributing

Refer to CONTRIBUTING.md for more information.

License

This project is licensed using the MIT license agreement. View LICENSE.md for more information.

uwaterlooapidotnet's People

Contributors

kade-robertson avatar

Watchers

James Cloos avatar  avatar  avatar

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.