gitset 0.0.0 → 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gitset.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 John Britton
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,78 @@
+# Gitset - A data collection and curation tool for humans
+
+Gitset is essentially a key-value store. The key is a path to a file on disk and the value is the contents of that file. The goal is to make collaborating on creating and curating datasets as easy as it is to contribute to an open source code project.
+
+Gitset is not intended to be used as a database, rather it should be used to manage a canonical data source that is imported into a "real" database for production use. On your mark, gitset, go!
+
+## Installation
+If you haven't already done so, [set up git](https://help.github.com/articles/set-up-git). It's a prerequisite. Once you've done that, you can install gitset from rubygems:
+
+    gem install gitset
+
+## Usage
+
+### Create a new dataset
+1. Create a project directory
+
+  ```
+  mkdir /path/to/project
+  cd /path/to/project
+  ```
+
+2. Create a YAML template to be used for new data points
+
+  ```yaml
+  # template.yaml
+  --- 
+  name: Full Name
+  emails:
+    - mail1@example.com
+    - mail2@example.net
+    - mail3@example.org
+  ```
+
+3. Initialize the project with your template
+
+  ```
+  gitset init template.yaml
+  ```
+
+### Clone an existing dataset
+    gitset clone git://github.com/username/datasetname.git
+
+### Working with a dataset
+1. Add a new data point using the template
+
+  ```
+  gitset create path/to/datapoint.yaml
+  ```
+
+2. Edit the template
+
+  ```yaml
+  # path/to/datapoint.yaml
+  --- 
+  name: John Britton
+  emails:
+    - public@johndbritton.com
+  ```
+
+3. Stage your changes
+
+  ```
+  git add path/to/datapoint.yaml
+  ```
+
+4. Commit your changes
+
+  ```
+  git commit -m 'Added a person'
+  ```
+
+Use standard git to modify existing datapoints in your dataset and commit the changes.
+
+___BUT WAIT, THERE'S MORE!___
+* Branch the dataset
+* Contribute to a dataset
+* Merge contributions
+* Filter the dataset

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/gitset

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'gitset'
+
+puts "hello"

data/gitset.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gitset/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "gitset"
+  gem.version       = Gitset::VERSION
+  gem.authors       = ["John Britton"]
+  gem.email         = ["public@johndbritton.com"]
+  gem.description   = %q{A data collection and curation tool for humans}
+  gem.summary       = %q{GitSet}
+  gem.homepage      = "http://github.com/johndbritton/gitset"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/gitset/version.rb

@@ -0,0 +1,3 @@
+module Gitset
+  VERSION = "0.0.1"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitset
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,15 +9,25 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-27 00:00:00.000000000 Z
+date: 2013-02-13 00:00:00.000000000 Z
 dependencies: []
 description: A data collection and curation tool for humans
-email: public@johndbritton.com
-executables: []
+email:
+- public@johndbritton.com
+executables:
+- gitset
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/gitset
+- gitset.gemspec
 - lib/gitset.rb
+- lib/gitset/version.rb
 homepage: http://github.com/johndbritton/gitset
 licenses: []
 post_install_message: 
@@ -41,5 +51,5 @@ rubyforge_project:
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: Gitset
+summary: GitSet
 test_files: []