https://github.com/envkey/envkey-dotnet

EnvKey's Nuget .NET library. Protect API keys and credentials. Keep configuration in sync.
https://github.com/envkey/envkey-dotnet

Last synced: 8 days ago
JSON representation

EnvKey's Nuget .NET library. Protect API keys and credentials. Keep configuration in sync.

• Host: GitHub
• URL: https://github.com/envkey/envkey-dotnet
• Owner: envkey
• License: mit
• Created: 2018-04-17T19:23:28.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-10-26T19:10:45.000Z (about 1 year ago)
• Last Synced: 2024-05-15T20:20:49.375Z (6 months ago)
• Language: C#
• Size: 5.04 MB
• Stars: 3
• Watchers: 5
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# EnvKey for .net Framework

* EnvKey [![NuGet version](https://badge.fury.io/nu/EnvKey.svg)](https://badge.fury.io/nu/EnvKey)

* EnvKey.Sdk [![NuGet version](https://badge.fury.io/nu/EnvKey.Sdk.svg)](https://badge.fury.io/nu/EnvKey.Sdk)

* EnvKey.Platform.Windows64 [![NuGet version](https://badge.fury.io/nu/EnvKey.Platform.Windows64.svg)](https://badge.fury.io/nu/EnvKey.Platform.Windows64)

* EnvKey.Platform.Linux64 [![NuGet version](https://badge.fury.io/nu/EnvKey.Platform.Linux64.svg)](https://badge.fury.io/nu/EnvKey.Platform.Linux64)

* EnvKey.Platform.Osx64 [![NuGet version](https://badge.fury.io/nu/EnvKey.Platform.Osx64.svg)](https://badge.fury.io/nu/EnvKey.Platform.Osx64)

[EnvKey Releases](https://github.com/envkey/envkey/releases?q=envkeysource)

The current envkey nuget package supports only windows on x64.

If you wish to use it on linux or mac please [open an issue](https://github.com/envkey/envkey-dotnet/issues) to show your demand.

# Usage

```cs

var envKey = new EnvKeyConfig();

var success = envKey.Load();

Stripe.ApiKey = Environment.GetEnvironmentVariable("STRIPE_SECRET_KEY");

```

## Building

### Preface

Versions of envkey should go hand in hand with the nuget package version to keep things tidy.  

That means that a envkey version 2.0.7 should be downlaoded (via `download_envkey.bat`) and a package should be generated with version 2.0.7 (via `build.bat` and `pack.bat`).  

To release library changes that refer to a certain version of envkey, the package should get a build-version extension, eg. 2.0.7.**3**.

### Requirements

To keep things simple you need to install Visual Studio 2017.

Run `NuGet\download_envkey.bat`. This will download the envkey executable. You'll asked for a version number of envkey.

### Build

Run `NuGet\build.bat`. This will restore all packages and creates a clean release build.

### Run Tests

Run `NuGet\runtests.bat "YOUR_KEY"`. This will execute all the test console applications in various .net configurations.  

Be aware that the tests use the nuget packages to be sure that they're working.

To ease the process of testing, the NuGet folder is marked as nuget source folder so you can create a nuget package (via `pack.bat`) and update the packages via VisualStudio using the `Local EnvKey Nuget Folder` source.

### Nuget Publish

run `NuGet\pack.bat` to create a package. You'll be asked to provide a version number.  

"1.0.2" will create a package with the version 1.0.2  

"2.0.7-??" where "??" can be everything from a name to other version numers to mark the package as prerelease.

Run `NuGet\push.bat` to upload the package to nuget. You'll be asked to provide an api key to identify yourself als owner of the package.  

Please refere to [the documentation](https://www.nuget.org/account/apikeys) how to obtain an api key.