https://github.com/qri-io/qri-datapackage

datapackage / qri dataset interop command line client
https://github.com/qri-io/qri-datapackage

Last synced: 6 days ago
JSON representation

datapackage / qri dataset interop command line client

• Host: GitHub
• URL: https://github.com/qri-io/qri-datapackage
• Owner: qri-io
• License: gpl-3.0
• Created: 2019-03-01T16:52:11.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-06-04T01:47:12.000Z (over 5 years ago)
• Last Synced: 2024-04-25T00:19:21.908Z (7 months ago)
• Language: Go
• Size: 55.7 KB
• Stars: 0
• Watchers: 5
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# qri-datapackage

Command Line tool for integrating Qri with the [Frictionless Data Datapackage format](https://frictionlessdata.io/data-packages/). Currently a work-in-progress proof-of concept type thing.

```

$ qri-datapackage

open knowledge foundation datapackage qri integration

Usage:

   [command]

Available Commands:

  export      write a qri dataset as a datapackage zip archive

  help        Help about any command

  import      import a datapackage into qri

Flags:

      --debug   show debug output

  -h, --help    help for this command

Use " [command] --help" for more information about a command.

```

# Installation

This is a bit of an experiment, so for now we're hoping you're ok with building from source. If others want it we can distribute binaries:

1. You'll need go installed: https://golang.org, installation should include instructions for getting `$GOPATH/bin` on your `$PATH`, be sure to follow those for easy next steps.

2. You'll need the Qri command line client, instructions for setup are here: https://github.com/qri-io/qri#building-from-source. If can type `qri` in a terminal & see instructions, you're good to go.

3. All that's left is to get this package:

```

$ go get -u github.com/qri-io/qri-datapackage

```

Which will place a new binary called `qri-datapackage` at `$GOPATH/bin`, which (ideally) means you can just type `qri-datapackage`, and it'll show a help message.

If you have _any issue at all_, hit up our discord chat: https://discord.gg/etap8Gb, someone should be able to help.

# Usage

For now the flow is pretty limited, import from datapackage, repeat as necessary to create new versions, then export.

```

$ cd path/to/folder/with_datapackage

$ qri-datapackage import datapackage.json

dataset saved: b5/human_services_data@QmSyDX5LYTiwQi861F5NAwdHrrnd1iRGsoEvCyzQMUyZ4W/ipfs/Qmda9B5BQesk8gXMPJnubGThgkny9AiEB7CLHSwkXHY4LA

# prove nothing changed by repeating:

$ qri-datapackage import datapackage.json

error saving: no changes detected

qri error: exit status 1

$ qri-datapackage export me/human_services_data

exported datapackage .zip archive to: human_services_data_datapackage.zip

```