Skip to content

Commit c0e67b7

Browse files
mortenpimortenpi
authored
Merge pull request #68 from JuliaComputing/mp/master-to-0.28
"Revert" master back to 0.2 branch
2 parents bdaa1ff + 1cb661e commit c0e67b7

34 files changed

+1586
-2236
lines changed

‎.github/workflows/ci.yml

+2-1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ on:
33
push:
44
branches:
55
- master
6+
- release-*
67
tags: '*'
78
pull_request:
89
jobs:
@@ -48,7 +49,7 @@ jobs:
4849
- uses: actions/checkout@v2
4950
- uses: julia-actions/setup-julia@latest
5051
with:
51-
version: '1'
52+
version: '1.6'
5253
- run: julia --project=docs -e '
5354
using Pkg;
5455
Pkg.develop(PackageSpec(; path=pwd()));

‎.gitignore

-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1 @@
11
Manifest.toml
2-
/docs/build
3-
/docs/Manifest.toml

‎Project.toml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name = "DataSets"
22
uuid = "c9661210-8a83-48f0-b833-72e62abce419"
33
authors = ["Chris Foster <[email protected]> and contributors"]
4-
version = "0.2.6"
4+
version = "0.2.10"
55

66
[deps]
77
AbstractTrees = "1520ce14-60c1-5f80-bbc7-55ef81b5835c"
@@ -15,7 +15,7 @@ TOML = "fa267f1f-6049-4f14-aa54-33bafae1ed76"
1515
UUIDs = "cf7118a7-6976-5b1a-9a39-7adc72f591a4"
1616

1717
[compat]
18-
AbstractTrees = "0.4"
18+
AbstractTrees = "0.3,0.4"
1919
ReplMaker = "0.2"
2020
ResourceContexts = "0.1,0.2"
2121
TOML = "1"

‎docs/Manifest.toml

+147
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,147 @@
1+
# This file is machine-generated - editing it directly is not advised
2+
3+
[[ArgTools]]
4+
uuid = "0dad84c5-d112-42e6-8d28-ef12dabb789f"
5+
6+
[[Artifacts]]
7+
uuid = "56f22d72-fd6d-98f1-02f0-08ddc0907c33"
8+
9+
[[Base64]]
10+
uuid = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"
11+
12+
[[Dates]]
13+
deps = ["Printf"]
14+
uuid = "ade2ca70-3891-5945-98fb-dc099432e06a"
15+
16+
[[DocStringExtensions]]
17+
deps = ["LibGit2", "Markdown", "Pkg", "Test"]
18+
git-tree-sha1 = "9d4f64f79012636741cf01133158a54b24924c32"
19+
uuid = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
20+
version = "0.8.4"
21+
22+
[[Documenter]]
23+
deps = ["Base64", "Dates", "DocStringExtensions", "IOCapture", "InteractiveUtils", "JSON", "LibGit2", "Logging", "Markdown", "REPL", "Test", "Unicode"]
24+
git-tree-sha1 = "3ebb967819b284dc1e3c0422229b58a40a255649"
25+
uuid = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
26+
version = "0.26.3"
27+
28+
[[Downloads]]
29+
deps = ["ArgTools", "LibCURL", "NetworkOptions"]
30+
uuid = "f43a241f-c20a-4ad4-852c-f6b1247861c6"
31+
32+
[[IOCapture]]
33+
deps = ["Logging"]
34+
git-tree-sha1 = "377252859f740c217b936cebcd918a44f9b53b59"
35+
uuid = "b5f81e59-6552-4d32-b1f0-c071b021bf89"
36+
version = "0.1.1"
37+
38+
[[InteractiveUtils]]
39+
deps = ["Markdown"]
40+
uuid = "b77e0a4c-d291-57a0-90e8-8db25a27a240"
41+
42+
[[JSON]]
43+
deps = ["Dates", "Mmap", "Parsers", "Unicode"]
44+
git-tree-sha1 = "81690084b6198a2e1da36fcfda16eeca9f9f24e4"
45+
uuid = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"
46+
version = "0.21.1"
47+
48+
[[LibCURL]]
49+
deps = ["LibCURL_jll", "MozillaCACerts_jll"]
50+
uuid = "b27032c2-a3e7-50c8-80cd-2d36dbcbfd21"
51+
52+
[[LibCURL_jll]]
53+
deps = ["Artifacts", "LibSSH2_jll", "Libdl", "MbedTLS_jll", "Zlib_jll", "nghttp2_jll"]
54+
uuid = "deac9b47-8bc7-5906-a0fe-35ac56dc84c0"
55+
56+
[[LibGit2]]
57+
deps = ["Base64", "NetworkOptions", "Printf", "SHA"]
58+
uuid = "76f85450-5226-5b5a-8eaa-529ad045b433"
59+
60+
[[LibSSH2_jll]]
61+
deps = ["Artifacts", "Libdl", "MbedTLS_jll"]
62+
uuid = "29816b5a-b9ab-546f-933c-edad1886dfa8"
63+
64+
[[Libdl]]
65+
uuid = "8f399da3-3557-5675-b5ff-fb832c97cbdb"
66+
67+
[[Logging]]
68+
uuid = "56ddb016-857b-54e1-b83d-db4d58db5568"
69+
70+
[[Markdown]]
71+
deps = ["Base64"]
72+
uuid = "d6f4376e-aef5-505a-96c1-9c027394607a"
73+
74+
[[MbedTLS_jll]]
75+
deps = ["Artifacts", "Libdl"]
76+
uuid = "c8ffd9c3-330d-5841-b78e-0817d7145fa1"
77+
78+
[[Mmap]]
79+
uuid = "a63ad114-7e13-5084-954f-fe012c677804"
80+
81+
[[MozillaCACerts_jll]]
82+
uuid = "14a3606d-f60d-562e-9121-12d972cd8159"
83+
84+
[[NetworkOptions]]
85+
uuid = "ca575930-c2e3-43a9-ace4-1e988b2c1908"
86+
87+
[[Parsers]]
88+
deps = ["Dates"]
89+
git-tree-sha1 = "c8abc88faa3f7a3950832ac5d6e690881590d6dc"
90+
uuid = "69de0a69-1ddd-5017-9359-2bf0b02dc9f0"
91+
version = "1.1.0"
92+
93+
[[Pkg]]
94+
deps = ["Artifacts", "Dates", "Downloads", "LibGit2", "Libdl", "Logging", "Markdown", "Printf", "REPL", "Random", "SHA", "Serialization", "TOML", "Tar", "UUIDs", "p7zip_jll"]
95+
uuid = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
96+
97+
[[Printf]]
98+
deps = ["Unicode"]
99+
uuid = "de0858da-6303-5e67-8744-51eddeeeb8d7"
100+
101+
[[REPL]]
102+
deps = ["InteractiveUtils", "Markdown", "Sockets", "Unicode"]
103+
uuid = "3fa0cd96-eef1-5676-8a61-b3b8758bbffb"
104+
105+
[[Random]]
106+
deps = ["Serialization"]
107+
uuid = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
108+
109+
[[SHA]]
110+
uuid = "ea8e919c-243c-51af-8825-aaa63cd721ce"
111+
112+
[[Serialization]]
113+
uuid = "9e88b42a-f829-5b0c-bbe9-9e923198166b"
114+
115+
[[Sockets]]
116+
uuid = "6462fe0b-24de-5631-8697-dd941f90decc"
117+
118+
[[TOML]]
119+
deps = ["Dates"]
120+
uuid = "fa267f1f-6049-4f14-aa54-33bafae1ed76"
121+
122+
[[Tar]]
123+
deps = ["ArgTools", "SHA"]
124+
uuid = "a4e569a6-e804-4fa4-b0f3-eef7a1d5b13e"
125+
126+
[[Test]]
127+
deps = ["InteractiveUtils", "Logging", "Random", "Serialization"]
128+
uuid = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
129+
130+
[[UUIDs]]
131+
deps = ["Random", "SHA"]
132+
uuid = "cf7118a7-6976-5b1a-9a39-7adc72f591a4"
133+
134+
[[Unicode]]
135+
uuid = "4ec0a83e-493e-50e2-b9ac-8f72acf5a8f5"
136+
137+
[[Zlib_jll]]
138+
deps = ["Libdl"]
139+
uuid = "83775a58-1f1d-513f-b197-d71354ab007a"
140+
141+
[[nghttp2_jll]]
142+
deps = ["Artifacts", "Libdl"]
143+
uuid = "8e850ede-7688-5339-a07c-302acd2aaf8d"
144+
145+
[[p7zip_jll]]
146+
deps = ["Artifacts", "Libdl"]
147+
uuid = "3f19e933-33d8-53b3-aaab-bd5110c3b7a0"

‎docs/Project.toml

-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,2 @@
11
[deps]
22
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
3-
4-
[compat]
5-
Documenter = "0.27"

‎docs/src/Data.toml

+6-6
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ uuid="b498f769-a7f6-4f67-8d74-40b770398f26"
1313
[datasets.storage]
1414
# The name of the storage driver.
1515
driver="FileSystem"
16-
# Data stored in FileSystem is either File (a file) or FileTree (a directory/folder)
17-
type="File"
16+
# Data stored in FileSystem is either Blob (a file) or BlobTree (a directory/folder)
17+
type="Blob"
1818
# Path with posix `/` separators.
19-
# Relative paths are relative to the location of Data.toml
20-
path="data/file.txt"
19+
# Use @__DIR__ for paths relative to Data.toml
20+
path="@__DIR__/data/file.txt"
2121

2222
# A second example
2323
[[datasets]]
@@ -27,8 +27,8 @@ uuid="e7fd7080-e346-4a68-9ca9-98593a99266a"
2727

2828
[datasets.storage]
2929
driver="FileSystem"
30-
type="FileTree"
31-
path="data/csvset"
30+
type="BlobTree"
31+
path="@__DIR__/data/csvset"
3232

3333
# Further datasets can be added as desired
3434
# [[datasets]]

‎docs/src/reference.md

+9-23
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,12 @@
33
## Using datasets
44

55
The primary mechanism for loading datasets is the `dataset` function, coupled
6-
with `open()` to open the resulting `DataSet` as some Julia type.
6+
with `open()` to open the resulting `DataSet` as some Julia type. In addition,
7+
DataSets.jl provides two macros [`@datafunc`](@ref) and [`@datarun`](@ref) to
8+
help in creating program entry points and running them.
79

810
```@docs
911
dataset
10-
```
11-
12-
In addition, DataSets.jl provides two macros [`@datafunc`](@ref) and
13-
[`@datarun`](@ref) to help in creating program entry points and running them.
14-
Note that these APIs aren't fully formed and might be deprecated before
15-
DataSets-1.0.
16-
17-
```@docs
1812
@datafunc
1913
@datarun
2014
```
@@ -52,31 +46,23 @@ DataSets.ActiveDataProject
5246
DataSets.TomlFileDataProject
5347
```
5448

55-
### Modifying datasets
56-
57-
The metadata for a dataset may be updated using `config!`
58-
59-
```@docs
60-
DataSets.config!
61-
```
62-
6349
## Data Models for files and directories
6450

65-
DataSets provides some builtin data models [`File`](@ref) and
66-
[`FileTree`](@ref) for accessin file- and directory-like data respectively. For
51+
DataSets provides some builtin data models [`Blob`](@ref) and
52+
[`BlobTree`](@ref) for accessin file- and directory-like data respectively. For
6753
modifying these, the functions [`newfile`](@ref) and [`newdir`](@ref) can be
68-
used.
54+
used, together with `setindex!` for `BlobTree`.
6955

7056
```@docs
71-
File
72-
FileTree
57+
Blob
58+
BlobTree
7359
newfile
7460
newdir
7561
```
7662

7763
## Storage Drivers
7864

79-
To add a new kind of data storage backend, call [`DataSets.add_storage_driver`](@ref)
65+
To add a new kind of data storage backend, implement [`DataSets.add_storage_driver`](@ref)
8066

8167
```@docs
8268
DataSets.add_storage_driver

0 commit comments

Comments
 (0)