npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@sanalabs/cli

v0.1.3

Published

Sana CLI

Downloads

4

Readme

Sana CLI

Command line tool for syncing data with the Sana Learn API from JSON files.

Install

npm install -g @sanalabs/cli

This installs the command sana.

Usage

Usage: sana [options] [command]

Sana Web API Wrapper

Options:
  -v, --version            output the version number
  -h, --help               output usage information

Commands:
  upload-events [options]  Upload user_events into Sana Web API
  upload-assets [options]  Upload assets into Sana Web API
  upload-views [options]   Upload views into Sana Web API

For each data type the json file should be as follows, where UserEventObject, AssetObject and ViewObject are defined in the API documentation.

upload-events

{
  "user_events": [ UserEventObject, ... ]
}

upload-assets

{
  "assets": [ AssetObject, ... ]
}

upload-views

{
  "views": [ ViewObject, ... ]
}

Full example

sana upload-assets --json-file content.json --api-key $API_KEY
sana upload-views --json-file content.json --api-key $API_KEY

content.json:

{
  "assets": [
    {
      "id": "asset_1",
      "type": "exercise"
    },
    {
      "id": "asset_2",
      "type": "exercise"
    },
    {
      "id": "asset_3",
      "type": "exercise"
    },
    {
      "id": "asset_4",
      "type": "exercise"
    }
  ],
  "views": [
    {
      "id": "view_1",
      "name": "Course 1",
      "items": [
        {
          "asset_id": "asset_1",
          "path": "/section_1",
          "attributes": {
            "partner_difficulty": 0.0
          }
        },
        {
          "asset_id": "asset_2",
          "path": "/section_1",
          "attributes": {
            "partner_difficulty": 0.33
          }
        },
        {
          "asset_id": "asset_3",
          "path": "/section_2",
          "attributes": {
            "partner_difficulty": 0.66
          }
        },
        {
          "asset_id": "asset_4",
          "path": "/section_2",
          "attributes": {
            "partner_difficulty": 1.0
          }
        }
      ]
    }
  ]
}
sana upload-events --json-file events.json --api-key $API_KEY

events.json:

{
  "user_events": [
    {
      "user": {
        "id": "user_1",
        "type": "tester"
      },
      "type": "response_submit",
      "timestamp": "2019-06-25T21:59:53.740Z",
      "is_offline_event": true,
      "attributes": {
        "view_id": "view_1",
        "asset_id": "asset_1",
        "result": "correct",
        "score": 1,
        "time_spent_ms": 60000
      }
    }
  ]
}

Requirements

Node.js v10 or later.

Develop and deploy

Publish new version:

npm version 1.2.3 # or manually update package.json and set git tag
git push --follow-tags

GitLab CI will automatically test and publish the package. See .gitlab-ci.yml.