forked from openknowledge-archive/dpm-old
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[doc/plan][s]: add a plan to doc detailing (incompletely) ideas aroun…
…d source data packages.
- Loading branch information
1 parent
60558f1
commit 40e92d9
Showing
1 changed file
with
93 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,93 @@ | ||
=========================================== | ||
Data Package Manager - New Plan Autumn 2011 | ||
=========================================== | ||
|
||
|
||
The two roles: | ||
|
||
* dpm as a data *package* manager - like pip, gem, apt-get | ||
* dpm as a data *source* manager - like mercurial / git / ... | ||
|
||
dpm as pure *package* manager | ||
----------------------------- | ||
|
||
Commands:: | ||
|
||
dpm search | ||
dpm info | ||
dpm install | ||
dpm publish | ||
|
||
dpm as source package manager | ||
----------------------------- | ||
|
||
Commands:: | ||
|
||
dpm clone | ||
dpm init | ||
dpm push | ||
dpm add | ||
|
||
Creating source data package from scratch:: | ||
|
||
$ dpm init {name} | ||
> ask you a few questions | ||
Your source data package has been created at ... | ||
# create csv | ||
$ cp /some/path/to/my.csv data/my.csv | ||
$ dpm add data/my.csv | ||
$ dpm status | ||
Staged files are ... | ||
# Now upload | ||
$ dpm push | ||
Pushing to ... | ||
|
||
Working on existing:: | ||
|
||
$ dpm clone {url} {path} | ||
... | ||
$ edit some files | ||
$ dpm add {changed files} | ||
$ dpm push ... | ||
|
||
Source package layout | ||
~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
Same as normal package but in addition have .dpm directory:: | ||
|
||
datapackage.json | ||
.dpm/ | ||
config | ||
manifest | ||
.dpm/config file | ||
~~~~~~~~~~~~~~~~ | ||
|
||
Looks like:: | ||
|
||
[remote] | ||
# ckan url | ||
url = http://test.ckan.org/ | ||
|
||
.dpm/manifest | ||
~~~~~~~~~~~~~ | ||
|
||
List of files that we manage and their connection to remote webstore. On push this needs to sync with datapackage.json:: | ||
|
||
{resource} | ||
local_path | ||
webstore_url | ||
state: new, unchanged, changed, deleted | ||
syncinfo: { | ||
unique_columns: | ||
} | ||
|
||
|
||
Questions | ||
~~~~~~~~~ | ||
|
||
* Duplication of datapackage.json and .dpm/config and .dpm/manifest? | ||
|