Skip to content

Latest commit

 

History

History
30 lines (23 loc) · 3.97 KB

README.md

File metadata and controls

30 lines (23 loc) · 3.97 KB
Raw

KEGG Logo

DotKEGG

Latest stable release: N/A (it's still in alpha, yo!)
Latest pre-release: v0.4.0-alpha

About

DotKEGG is a light-weight, user-friendly .NET wrapper for the Kyoto Encyclopedia of Genes and Genomes (KEGG) API. This library allows developers to make calls to the KEGG API with simple method calls, rather than building their own HTTP clients and request URIs, and return results as strongly typed lists, rather than having to parse raw text. I originally developed DotKEGG as a data layer for my work-in-progress game, Cell. However, I quickly realized that the library would also be useful to those (proud few!) bioinformatics/genomics researchers who build processing tools targeting the .NET Framework, so I made it free and open source!

Documentation

Documentation for DotKEGG, including full API Reference, is availabe at https://docs.dotkegg.com now only available within the DotKEGG.Docs and DotKEGG.Examples folders; I have taken down the online docs as of 2020-12-13. If you can't find the answer you're looking for there, please fill out an issue so I can help future users better understand this tool.

Issue Reporting

I'm not perfect; bugs happen. If you experience any issues with DotKEGG, please report them on this repository's Issue Tracker.

Building

I'll assume you know how to clone this repository and open the solution in Visual Studio. Here are some additional requirements/suggestions:

  • Visual Studio 2017 or later is required.
  • The solution has Debug, Release, and Test build configurations.
    • The unit-test project (DotKEGG.Test) is only built in the Test configuration. I rely on the NUnit library for unit testing. You must run these tests and make sure they all pass before submitting a pull request. Otherwise, if you don't care about running the tests, you should build in Debug or just delete this project from your solution.
    • The examples project (DotKEGG.Examples) is only built in the Release configuration. It simply makes sure that all examples referenced in the documentation will actually compile. If you don't care about building the Examples, you should build in Debug or just delete this project from your solution.
    • The documentation project (DotKEGG.Docs) is only built in the Release configuration. If you want to build the documentation project, make sure that you install the SandCastle Help File Builder (latest release available here). If not, you should build in Debug or just delete this project from your solution so that Visual Studio doesn't complain about the .shfbproj project type.
    • The NuGet package (.nupkg) is only built in the Release configuration. You will need to install the latest NuGet command-line client and add it to your path for this build step to succeed. If you don't care about building the NuGet package, you should build in Debug or just delete this build step from DotKEGG.csproj.
  • To view or modify the YAML CloudFormation template for the documentation website, you can use a basic editor like Notepad++, or install the YAML Editor VS extension.

License

DotKEGG is distributed under the terms of the MIT License. That means you can do pretty much anything you want with it, as long as you give me some credit and don't blame us when you fork the repo and break everything!