A CLI tool to create a valid BagIt SIP for SLUBArchiv.
As a user, you have three options `copy``move` or `replace` to create your SIP.
These options are based on payload files, which would be saved in data directory of your bag.
NOTE: use option `copy` if you are not sure how to restore your payload files, when something goes wrong!
As a user, you have three options to create your SIP: `copy`, `move` or `replace`.
NOTE: The use of option `copy` is strongly recommended. The other options modify your source directory, please use this with caution!
## Operating Systems
* Windows 10 (NOTE: check if UTF-8 flag set at `Systemadministration/TimeAndRegion/Region/Administration/AreaPattern`, if you want to use such characters as äöüÄÖÜß)
* Debian 10
## Requirements
* Perl version 5.28 or higher, as all necessary modules required
* Module Archive::BagIt::Base 0.065 or higher
* Perl version 5.28 or higher
* cpan or cpanm
* several CPAN modules such as Archive::BagIt::Base (0.065 or higher)
## Three ways to install a module
* with cpan `cpan Archive::BagIt`
* with cpanm `cpanm Archive::BagIt` (NOTE: `cpan App::cpanminus` must be installed). To force installation run `cpanm -i -f Archive::BagIt`.
*manual as downloaded package
1. Download for example Archive-BagIt-0.065.tar.gz from [metacpan Archive::BagIt](https://metacpan.org/pod/Archive::BagIt)
2. Extract it with `tar zxf Archive-BagIt-0.065.tar.gz` and go to project dir with `cd in Archive-BagIt-0.065`
* with cpanm `cpanm Archive::BagIt` (NOTE: `cpan App::cpanminus` must be installed).
*from source (Linux)
1. Download for example Archive-BagIt-0.067.tar.gz from [metacpan Archive::BagIt](https://metacpan.org/pod/Archive::BagIt)
2. Extract it with `tar zxf Archive-BagIt-0.067.tar.gz` and go to project dir with `cd in Archive-BagIt-0.067`
3. Run `perl Makefile.pl`
4.`(d)gmake`
5.`(d)gmake test`
6.`(d)gmake install`
7. with `cpanm Archive::BagIt` test for version. Result will be something like `Archive::BagIt is up to date (0.065)`.
7. with `cpanm Archive::BagIt` test for the version. Result will be something like `Archive::BagIt is up to date (0.067)`.
## Module deinstallation
Using cpanm is recommended for an assisted and clean uninstall.
1.`cpan App::cpanminus` must be installed.
2. Run `cpanm --uninstall Archive::BagIt`
## Documentation
* RECOMMENDED: Windows 10 perl environment [strawberry-perl-5.30.3.1-64bit-portable](http://strawberryperl.com/releases.html)
* RECOMMENDED for Windows 10: strawberry perl environment [strawberry-perl-5.30.3.1-64bit-portable](http://strawberryperl.com/releases.html)
(includes `cpanm` with many preinstalled CPAN modules)
* Project based on BagIt 1.0 specification, visit [RFC8493](https://tools.ietf.org/html/rfc8493)
*Some valid Bag examples based on operation system look at `export_dir_kitodo/bagit/lin_*` or `export_dir_kitodo/bagit/win_*`
* Specification of creating a SLUB SIP you can find at[SLUBArchiv_Produzenten_SIP_Spezifikation.pdf](https://slubarchiv.slub-dresden.de/technische-standards-fuer-die-ablieferung-von-digitalen-dokumenten/)
*For rights coding specification visit [SLUBArchiv_Produzenten_Rechteauszeichnung.pdf](https://slubarchiv.slub-dresden.de/technische-standards-fuer-die-ablieferung-von-digitalen-dokumenten/)
*For valid SIP examples based on operating system please have a look at `export_dir_kitodo/bagit/lin_*` or `export_dir_kitodo/bagit/win_*`
* Specification for creating a SLUBArchiv SIP[SLUBArchiv_Produzenten_SIP_Spezifikation.pdf](https://slubarchiv.slub-dresden.de/technische-standards-fuer-die-ablieferung-von-digitalen-dokumenten/)
*SLUBArchiv rights coding specification [SLUBArchiv_Produzenten_Rechteauszeichnung.pdf](https://slubarchiv.slub-dresden.de/technische-standards-fuer-die-ablieferung-von-digitalen-dokumenten/)
### Explanation
##### Usage
...
...
@@ -122,7 +124,7 @@ EXAMPLES
```
##### Tests
* Start scipt in project directory to run all tests properly.
* Start script in project directory to run all tests properly.
* NOTE: while running tests path `tmp/bagit` will be created.
