Tutorial¶
Here’s how to use NSoT.
This document assumes that you’ve already have an instance of NSoT installed, configured, and running on your system. If you don’t, please either check out the Quick Start or head over to the full-blown Installation guide and then return here.
First Steps¶
Important
Because this is a work-in-progress, we’re going to use the command-line utility provided by the official NSoT client to get you acquainted with NSoT.
Install the Client¶
First things first, you’ll need to install pyNSoT, the official Python API client and CLI utility:
$ pip install pynsot
Configure the Client¶
After you’ve installed the client, please follow the pyNSoT Configuration guide to establish a
.pynsotrc
file.
Using the Command-Line¶
Once you’ve got a working nsot
CLI setup, please follow the pyNSoT
Command-Line guide. This
will get you familiarized with the basics of how NSoT works.
Understanding the Data Model¶
NSoT has a relatively simple data model, but the objects themselves can be quite sophisticated. Familiarize yourself with the Data Model.
Administering the Server¶
Familiarize with the nsot-server
command that is used to manage your server
instance by checking out the Server Administration guide.