JupyterSharp 1.0.0
dotnet add package JupyterSharp --version 1.0.0
NuGet\Install-Package JupyterSharp -Version 1.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="JupyterSharp" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add JupyterSharp --version 1.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: JupyterSharp, 1.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install JupyterSharp as a Cake Addin
#addin nuget:?package=JupyterSharp&version=1.0.0
// Install JupyterSharp as a Cake Tool
#tool nuget:?package=JupyterSharp&version=1.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
JupyterSharp
Access Jupyter API via Visual C#.
Description
.NET package to access Jupyter Notebook Server API via Visual C#.
Requirement
- .NET Standard 2.0
Usage
Installation
You can start using this package by two ways.
Quick Start
This is the sample code for getting contents of root directory.
using JupyterSharp;
using JupyterSharp.Common;
namespace JupyterSharp.Sample
{
public class Sample
{
private Api MyApi;
public Sample()
{
// Set your Jupyter Notebook access token, IP address and port
// Default IP address is localhost and port is 8888
MyApi = new Api("JUPYTER TOKEN", "localhost", "8888");
}
public void GetContentsRootDirectory()
{
// Get contents of root directory
var getRequest = MyApi.GetContents();
var getResponse = JsonConverter.ToObject<Common.Contents>(getRequest.Content);
// do something with getResponse
// ...
}
}
}
API Documentation
All wrapper API in this package are designed with Jupyter Notebook API.
- Contents
- Sessions
- Kernels
- Kernelspecs
- Config
- Terminals
- Status
- ApiSpec
Unit Test
This repository also includes a test project.
To run the tests, you have to do some preparations in advance as below.
- Jupyter Notebook is running at
http://localhost:8888
- Your Jupyter token is set to configuration key
JupyterToken
of JupyterSharp.Tests project
Contribution
- Fork this repository
- Create your feature branch
- Commit your changes
- Push to the branch
- Create new Pull Request
Licence
MIT License
Author
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
.NETStandard 2.0
- RestSharp (>= 106.6.9)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
1.0.0 | 526 | 7/10/2019 |