Giter VIP home page Giter VIP logo

datapackage-init-js's Introduction

datapackage-init

Create Data Package datapackage.json files.

Installation

NPM

npm install datapackage-init

Usage

Start off by requiring the module as follows:

var dpinit = require('datapackage-init');

init

Create a datapackage.json at the path specified.

dpinit.init(path, callback(err, datapackageJson));
  • path: path to where your data package is (will use this to search for data to add, for an existing datapackage.json to update etc)

create

Create a Data Package JSON and return it in the callback.

dpinit.create(path_, callback(err, datapackageJson));
  • path: path to where your data package data is located. This is used to search for data to add, for an existing datapackage.json to update etc)

simpleDefaults

Generate simple defaults for a datapackage.json

var defaults = dpinit.simpleDefaults();

defaultsForLocalPackage

Get defaults based on a local file-system data package

dpinit.defaultsForLocalPackage(path_, cb)
  • path_: path to the data package directory

Defaults here will include things like:

  • Generating a name based on the directory
  • Generating a description based on a README (if present)
  • Searching for data files (csv and geojson at present) and adding them to the resources

createResourceEntry

dpinit.createResourceEntry(filepath, cb)

Create a resource entry in a Data Package for file at filepath returning the data in the callback.

createResourceEntries

dpinit.createResourceEntries(dir, cb)

Create a set of resource entries for a Data Package for all suitable files in dir and its child directories.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.