Skip to content

Commit

Permalink
Release 1.2.0 (part II) (#33)
Browse files Browse the repository at this point in the history
* Update docs for 1.2.0
  • Loading branch information
zimeon committed Mar 24, 2021
1 parent ad76f3e commit 2f72087
Show file tree
Hide file tree
Showing 6 changed files with 23 additions and 23 deletions.
12 changes: 6 additions & 6 deletions docs/demo_build_spec_examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ WARNING:ocfl.object:### Inventory for v1
"type": "https://ocfl.io/1.0/spec/#inventory",
"versions": {
"v1": {
"created": "2020-09-22T17:11:53.521490Z",
"created": "2021-03-24T20:22:33.307165Z",
"state": {
"7dcc352f96c56dc...c31": [
"foo/bar.xml"
Expand Down Expand Up @@ -158,7 +158,7 @@ WARNING:ocfl.object:### Inventory for v2
"type": "https://ocfl.io/1.0/spec/#inventory",
"versions": {
"v1": {
"created": "2020-09-22T17:11:53.521490Z",
"created": "2021-03-24T20:22:33.307165Z",
"state": {
"7dcc352f96c56dc...c31": [
"foo/bar.xml"
Expand All @@ -172,7 +172,7 @@ WARNING:ocfl.object:### Inventory for v2
}
},
"v2": {
"created": "2020-09-22T17:11:53.523211Z",
"created": "2021-03-24T20:22:33.308961Z",
"state": {
"4d27c86b026ff70...b53": [
"foo/bar.xml"
Expand Down Expand Up @@ -237,7 +237,7 @@ WARNING:ocfl.object:### Inventory for v3
"type": "https://ocfl.io/1.0/spec/#inventory",
"versions": {
"v1": {
"created": "2020-09-22T17:11:53.521490Z",
"created": "2021-03-24T20:22:33.307165Z",
"state": {
"7dcc352f96c56dc...c31": [
"foo/bar.xml"
Expand All @@ -251,7 +251,7 @@ WARNING:ocfl.object:### Inventory for v3
}
},
"v2": {
"created": "2020-09-22T17:11:53.523211Z",
"created": "2021-03-24T20:22:33.308961Z",
"state": {
"4d27c86b026ff70...b53": [
"foo/bar.xml"
Expand All @@ -263,7 +263,7 @@ WARNING:ocfl.object:### Inventory for v3
}
},
"v3": {
"created": "2020-09-22T17:11:53.524550Z",
"created": "2021-03-24T20:22:33.310220Z",
"state": {
"4d27c86b026ff70...b53": [
"foo/bar.xml"
Expand Down
16 changes: 8 additions & 8 deletions docs/demo_ocfl_object_script.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The `--version` argument will show version number and exit

```
> python ocfl-object.py --version
ocfl-object.py is part of ocfl-py version 1.1.1
ocfl-object.py is part of ocfl-py version 1.2.0
```


Expand All @@ -35,7 +35,7 @@ WARNING:ocfl.object:### Inventory for v1
"type": "https://ocfl.io/1.0/spec/#inventory",
"versions": {
"v1": {
"created": "2020-09-22T17:11:54.810738Z",
"created": "2021-03-24T20:22:34.576958Z",
"state": {
"43a43fe8a8a082d3b5343dfaf2fd0c8b8e370675b1f376e92e9994612c33ea255b11298269d72f797399ebb94edeefe53df243643676548f584fb8603ca53a0f": [
"a_file.txt"
Expand Down Expand Up @@ -66,7 +66,7 @@ WARNING:ocfl.object:### Inventory for v1
"type": "https://ocfl.io/1.0/spec/#inventory",
"versions": {
"v1": {
"created": "2020-09-22T17:11:55.208197Z",
"created": "2021-03-24T20:22:34.974946Z",
"state": {
"43a43fe8a8a082d3b5343dfaf2fd0c8b8e370675b1f376e92e9994612c33ea255b11298269d72f797399ebb94edeefe53df243643676548f584fb8603ca53a0f": [
"a_file.txt"
Expand All @@ -91,15 +91,15 @@ WARNING:ocfl.object:### Inventory for v2
"type": "https://ocfl.io/1.0/spec/#inventory",
"versions": {
"v1": {
"created": "2020-09-22T17:11:55.208197Z",
"created": "2021-03-24T20:22:34.974946Z",
"state": {
"43a43fe8a8a082d3b5343dfaf2fd0c8b8e370675b1f376e92e9994612c33ea255b11298269d72f797399ebb94edeefe53df243643676548f584fb8603ca53a0f": [
"a_file.txt"
]
}
},
"v2": {
"created": "2020-09-22T17:11:55.209107Z",
"created": "2021-03-24T20:22:34.975605Z",
"state": {
"296e72b8fd5f7f0ac1473993600ae34953d5dab646f17e7b182b8648aff830d7bf01b56490777cb3e72b33fcc1ae520506badea1032252d1a55fd7362e269975": [
"a_file.txt"
Expand All @@ -124,23 +124,23 @@ WARNING:ocfl.object:### Inventory for v3
"type": "https://ocfl.io/1.0/spec/#inventory",
"versions": {
"v1": {
"created": "2020-09-22T17:11:55.208197Z",
"created": "2021-03-24T20:22:34.974946Z",
"state": {
"43a43fe8a8a082d3b5343dfaf2fd0c8b8e370675b1f376e92e9994612c33ea255b11298269d72f797399ebb94edeefe53df243643676548f584fb8603ca53a0f": [
"a_file.txt"
]
}
},
"v2": {
"created": "2020-09-22T17:11:55.209107Z",
"created": "2021-03-24T20:22:34.975605Z",
"state": {
"296e72b8fd5f7f0ac1473993600ae34953d5dab646f17e7b182b8648aff830d7bf01b56490777cb3e72b33fcc1ae520506badea1032252d1a55fd7362e269975": [
"a_file.txt"
]
}
},
"v3": {
"created": "2020-09-22T17:11:55.210083Z",
"created": "2021-03-24T20:22:34.976141Z",
"state": {
"43a43fe8a8a082d3b5343dfaf2fd0c8b8e370675b1f376e92e9994612c33ea255b11298269d72f797399ebb94edeefe53df243643676548f584fb8603ca53a0f": [
"a_file.txt"
Expand Down
2 changes: 1 addition & 1 deletion docs/demo_ocfl_sidecar_script.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The `--version` argument will show version number and exit

```
> python ocfl-sidecar.py --version
ocfl-sidecar.py is part of ocfl-py version 1.1.1
ocfl-sidecar.py is part of ocfl-py version 1.2.0
```


Expand Down
2 changes: 1 addition & 1 deletion docs/demo_ocfl_store_script.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The `--version` argument will show version number and exit (but we still tave to

```
> python ocfl-store.py --version --root=tmp/root --list
ocfl-store.py is part of ocfl-py version 1.1.1
ocfl-store.py is part of ocfl-py version 1.2.0
```


Expand Down
10 changes: 5 additions & 5 deletions docs/demo_using_bagit_bags.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,8 +161,8 @@ Taking the newly created OCFL object `/tmp/obj` we can `--extract` the `v4` cont
INFO:ocfl.object:Extracted v4 into tmp/extracted_v4
INFO:bagit:Creating bag for directory tmp/extracted_v4
INFO:bagit:Creating data directory
INFO:bagit:Moving my_content to /privatetmp/extracted_v4/tmpzk79a0t6/my_content
INFO:bagit:Moving /privatetmp/extracted_v4/tmpzk79a0t6 to data
INFO:bagit:Moving my_content to /privatetmp/extracted_v4/tmpmv9q6tbn/my_content
INFO:bagit:Moving /privatetmp/extracted_v4/tmpmv9q6tbn to data
INFO:bagit:Using 1 processes to generate manifests: sha512
INFO:bagit:Generating manifest lines for file data/my_content/dracula.txt
INFO:bagit:Generating manifest lines for file data/my_content/dunwich.txt
Expand All @@ -183,13 +183,13 @@ We note that the OCFL object had only one `content` file in `v4` but the extract
> diff -r tmp/extracted_v4 tests/testdata/bags/uaa_v4
diff -r tmp/extracted_v4/bag-info.txt tests/testdata/bags/uaa_v4/bag-info.txt
1,2c1
< Bag-Software-Agent: bagit.py v1.7.0 <https://github.com/LibraryOfCongress/bagit-python>
< Bagging-Date: 2020-09-22
< Bag-Software-Agent: bagit.py v1.8.1 <https://github.com/LibraryOfCongress/bagit-python>
< Bagging-Date: 2021-03-24
---
> Bagging-Date: 2020-01-04
diff -r tmp/extracted_v4/tagmanifest-sha512.txt tests/testdata/bags/uaa_v4/tagmanifest-sha512.txt
2c2
< 095d7cac097882aa2d6d63a34ff1bad13bef794796e4dad3f5474fffcaaf144b8f28e78665cca7c6aadfa9f7212a936060703d9428ef43b17425e1447eab01b6 bag-info.txt
< 4354c74d41f895abfcb617379a7a4114dcff7193a8f30ae27f8d5553fdecce4c533cfdf6f8f94ad2ab15adff22f0e5768ee8961f5ac6aa5156c79ae8a6642651 bag-info.txt
---
> 10624e6d45462def7af66d1a0d977606c7b073b01809c1d42258cfab5c34a275480943cbe78044416aee1f23822cc3762f92247b8f39b5c6ddc5ae32a8f94ce5 bag-info.txt
```
Expand Down
4 changes: 2 additions & 2 deletions docs/validation_status.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ The following tables show the implementation status of all errors and warnings i
| [E030](https://ocfl.io/1.0/spec#E030) | 'SHA-256 algorithm defined by [FIPS-180-4] and must be encoded using hex (base16) encoding [RFC4648].' | _Not implemented_ |
| [E031](https://ocfl.io/1.0/spec#E031) | 'SHA-512 algorithm defined by [FIPS-180-4] and must be encoded using hex (base16) encoding [RFC4648].' | _Not implemented_ |
| [E032](https://ocfl.io/1.0/spec#E032) | '[blake2b-512] must be encoded using hex (base16) encoding [RFC4648].' | _Not implemented_ |
| [E033](https://ocfl.io/1.0/spec#E033) | 'An OCFL Object Inventory MUST follow the [JSON] structure described in this section and must be named inventory.json.' | OCFL Object %s inventory is not valid JSON (%s) \[[ocfl/validator.py#L117](https://github.com/zimeon/ocfl-py/blob/main/ocfl/validator.py#L117)\] |
| [E033](https://ocfl.io/1.0/spec#E033) | 'An OCFL Object Inventory MUST follow the [JSON] structure described in this section and must be named inventory.json.' | OCFL Object %s inventory is not valid JSON (%s) \[[ocfl/validator.py#L117](https://github.com/zimeon/ocfl-py/blob/main/ocfl/validator.py#L117) [ocfl/object.py#L553](https://github.com/zimeon/ocfl-py/blob/main/ocfl/object.py#L553)\] |
| [E034](https://ocfl.io/1.0/spec#E034) | 'An OCFL Object Inventory must follow the [JSON] structure described in this section and MUST be named inventory.json.' | OCFL Object root inventory is missing \[[ocfl/validator.py#L84](https://github.com/zimeon/ocfl-py/blob/main/ocfl/validator.py#L84)\] |
| [E035](https://ocfl.io/1.0/spec#E035) | 'The forward slash (/) path separator must be used in content paths in the manifest and fixity blocks within the inventory.' | _Not implemented_ |
| [E036](https://ocfl.io/1.0/spec#E036) | 'An OCFL Object Inventory must include the following keys: [id, type, digestAlgorithm, head]' | _See multiple cases identified with suffixes below_ |
Expand Down Expand Up @@ -174,4 +174,4 @@ The following tables show the implementation status of all errors and warnings i
| [W014](https://ocfl.io/1.0/spec#W014) | 'Storage hierarchies within the same OCFL Storage Root SHOULD use just one layout pattern.' | _Not implemented_ |
| [W015](https://ocfl.io/1.0/spec#W015) | 'Storage hierarchies within the same OCFL Storage Root SHOULD consistently use either a directory hierarchy of OCFL Objects or top-level OCFL Objects.' | _Not implemented_ |

_Generated by `extract_codes.py` at 2020-09-22 13:04:11.283588_
_Generated by `extract_codes.py` at 2021-03-24 16:21:53.209724_

0 comments on commit 2f72087

Please sign in to comment.