Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updated docs and build #243

Merged
merged 1 commit into from
Jan 26, 2024
Merged

updated docs and build #243

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/build.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ['3.7', '3.8', '3.9', '3.10']
python-version: ['3.8', '3.9', '3.10', '3.11', '3.12']

steps:
- uses: actions/checkout@v2
Expand Down
5 changes: 4 additions & 1 deletion docs/using_mailbagit/mailbagit.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,10 +78,13 @@ e.g. `-d eml pdf warc`
> Compresses the mailbag as a ZIP, TAR, or TAR.GZ
> e.g. `-c zip` or `-c tar.gz`

* **-f, --companion_files**
* **-f, --companion-files**
> Allows for companion metadata files to be packaged alongside email export files.
> When this option is used, `mailbagit` will recursively include all the files in the directory provided into a mailbag.

* **-l, --external-links**
> Will crawl and add external `<a href="">` links to WARC derivatives as response records

### Bagit-python arguments

Mailbagit also accepts most [bagit-python](https://github.com/LibraryOfCongress/bagit-python) arguments. Thus, you can provide arguments like `--processes 2` or arguments to add metadata such as `--source-organization University at Albany, SUNY`
Expand Down
2 changes: 1 addition & 1 deletion docs/using_mailbagit/warcs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ nav_order: 9

# WARC Derivatives

`mailbagit` can create WARC derivatives for email messages. This is a bit of an experimental feature in that using web archives for email isn't common and there is no concensus yet on how these WARC should be strutured. Still, since WARCs do a good job of both preserving how messages are displayed as well as maintaining email messages as data, they can be really useful for email preservation. Thus, we're including this feature as an example for users to try out and experiment with. If you have thoughts or feedback on this, please [submit an issue](https://github.com/UAlbanyArchives/mailbagit/issues/new/choose)!
`mailbagit` can create WARC derivatives for email messages. This is a bit of an experimental feature in that using web archives for email isn't common and there is no concensus yet on how these WARC should be structured. Still, since WARCs do a good job of both preserving how messages are displayed as well as maintaining email messages as data, they can be really useful for email preservation. Thus, we're including this feature as an example for users to try out and experiment with. If you have thoughts or feedback on this, please [submit an issue](https://github.com/UAlbanyArchives/mailbagit/issues/new/choose)!

WARCs can be more challenging to use that typical files, as you need software to "replay" them. [ReplayWeb.Page](https://replayweb.page/) is an easy method, and you can checkout the [Web Archiving Awesome List](https://github.com/iipc/awesome-web-archiving#replay) for more. The WARC files created by `mailbagit` can also be small enough to view in a text editor. The files are compressed with gzip, so you just have to extract them to plain text.

Expand Down
Loading