https://github.com/amweiss/dark-sky-core

A .NET Standard Library for using the Dark Sky API.
https://github.com/amweiss/dark-sky-core

dark-sky netcore netstandard nuget

Last synced: 2 months ago
JSON representation

A .NET Standard Library for using the Dark Sky API.

• Host: GitHub
• URL: https://github.com/amweiss/dark-sky-core
• Owner: amweiss
• License: mit
• Archived: true
• Created: 2016-09-22T17:43:29.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2020-04-01T00:29:34.000Z (almost 5 years ago)
• Last Synced: 2024-10-01T19:46:25.816Z (3 months ago)
• Topics: dark-sky, netcore, netstandard, nuget
• Language: C#
• Homepage:
• Size: 347 KB
• Stars: 54
• Watchers: 6
• Forks: 14
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# ARCHIVED: [Apple has purchased Dark Sky and is shutting down the API, so I'm no longer supporting this.](https://blog.darksky.net/dark-sky-has-a-new-home/)

# Dark Sky Core

[![NuGet](https://img.shields.io/nuget/v/DarkSkyCore.svg?maxAge=2592000)](https://www.nuget.org/packages/DarkSkyCore) [![Build Status](https://dev.azure.com/amweiss/dark-sky-core/_apis/build/status/dark-sky-core-CI)](https://dev.azure.com/amweiss/dark-sky-core/_build/latest?definitionId=5) [![codecov](https://codecov.io/gh/amweiss/dark-sky-core/branch/master/graph/badge.svg)](https://codecov.io/gh/amweiss/dark-sky-core)

A .NET Standard Library for using the [Dark Sky API](https://darksky.net/dev/docs).

## Usage

The main class is [`DarkSkyService`](https://github.com/amweiss/dark-sky-core/blob/master/src/Services/DarkSkyService.cs). When using it you will need provide your API key after [signing up](https://darksky.net/dev/) for a dev account.

You can also provide an implementations of [`IHttpClient`](https://github.com/amweiss/dark-sky-core/blob/master/src/Services/IHttpClient.cs) and [`IJsonSerializerService`](https://github.com/amweiss/dark-sky-core/blob/master/src/Services/IJsonSerializerService.cs) if you want to replace the default [`ZipHttpClient`](https://github.com/amweiss/dark-sky-core/blob/master/src/Services/ZipHttpClient.cs) and [`JsonNetJsonSerializerService`](https://github.com/amweiss/dark-sky-core/blob/master/src/Services/JsonNetJsonSerializerService.cs)

for testing or other purposes.

Once you have an instance of the class, use `GetForecast` to use the API. The method by default is a [forecast](https://darksky.net/dev/docs/forecast) request.

If you specify a value for `ForecastDateTime` in an `OptionalParameters` instance it will become a [time machine](https://darksky.net/dev/docs/time-machine) request.

The responses all take the form of a [CamelCase](https://en.wikipedia.org/wiki/PascalCase) version of the [Dark Sky Response](https://darksky.net/dev/docs/response) in `DarkSkyResponse`.

This includes the [headers](https://darksky.net/dev/docs/response#response) and properties for the required text and link to use based on the [Terms of Service](https://darksky.net/dev/docs/terms).

```csharp

var darkSky = new DarkSky.Services.DarkSkyService(apiKey);

var forecast = await darkSky.GetForecast(42.915, -78.741);

if (forecast?.IsSuccessStatus == true)

{

    Console.WriteLine(forecast.Response.Currently.Summary);

}

else

{

    Console.WriteLine("No current weather data");

}

Console.WriteLine(forecast.AttributionLine);

Console.WriteLine(forecast.DataSource);

```

You can see more examples of usage in the [integration tests](https://github.com/amweiss/dark-sky-core/blob/master/tests/IntegrationTests/Services/DarkSkyServiceIntegrationTests.cs).

## Additional Information

[Code of Conduct](CODE_OF_CONDUCT.md) and [Contributing Guidelines](CONTRIBUTING.md) for the project.