Skip to content

questionmark/TinCan.NET

 
 

Repository files navigation

Info

A .NET Core C#/.NET library for implementing Tin Can API.

About

This project is a modification of Rustici Software's TinCan.NET Library https://github.com/RusticiSoftware/TinCan.NET and is licensed under the Apache 2.0 license. Also included is modifications from a pull request from github user "peturingi" to update the software for .NET Core, as well as add ActivityDefinition InteractionType. Both of these have not been merged into their master branch as of 8/7/18. Pull requests included: RusticiSoftware#35 (itself based on : RusticiSoftware#17 from 2015, user olivergurnell) RusticiSoftware#34

Modifications done by Neal Daniel (njvsvalhalla):

  • Standardized method, field, property, and variable names
  • Cleaned up code and made more readable
  • Added support for xAPI 1.0.3
  • LanguageMap was made with the ability to use an collect initializer
  • All calls in RemoteLRS are now async
  • The tests were updated to .NET core & fixed any broken tests
  • RemoteLRS tests were made async

Changes done by Mayur Agarwal (myself):

  • Fix for Group object type value. (If we use group in xAPI statement, it fails because of wrong object type value)
  • Merged all changes from original TinCan.NET repository upto Release 1.3.0.0
  • Added GitHub action to publish to Nuget feed

Parent Project

No new updates in parent project. Last checked: 2nd July, 2022

For hosted API documentation, basic usage instructions, supported version listing, etc. visit the main project website at: http://rusticisoftware.github.io/TinCan.NET/

For more information about the Tin Can API visit: http://tincanapi.com/

Generating new release and Nuget package

In Tincan.csproj file change the version number to the new release version. Merge the pull request with your changes. Using GitHub desktop create tag with release version on your merge commit and push the tag. Then create release with new tag on GitHub website and publish. GitHub action will automatically trigger a new release which will push the Nuget package to that Nuget feed. Note that we have nuget API token saved in GitHub repositories secrets which is valid for 1 year and should renew after expiry for GitHub action to work. To generate new token if expires please contact Mayur or transfer the release to new Nuget feed.

Installation

Include the TinCan folder in your project and reference the project.

Nuget package located here: https://www.nuget.org/packages/TinCanStandard