diff --git a/README.md b/README.md index 7edc3fd..202bffa 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,17 @@ Read the [article about Auto Archiver on bellingcat.com](https://www.bellingcat.com/resources/2022/09/22/preserve-vital-online-content-with-bellingcats-auto-archiver-tool/). -Python script to automatically archive social media posts, videos, and images from a Google Sheets document. Uses different archivers depending on the platform, and can save content to local storage, S3 bucket (Digital Ocean Spaces, AWS, ...), and Google Drive. The Google Sheets where the links come from is updated with information about the archived content. It can be run manually or on an automated basis. +Python tool to automatically archive social media posts, videos, and images from a Google Sheets, the console, and more. Uses different archivers depending on the platform, and can save content to local storage, S3 bucket (Digital Ocean Spaces, AWS, ...), and Google Drive. If using Google Sheets as the source for links, it will be updated with information about the archived content. It can be run manually or on an automated basis. + +There are 3 ways to use the auto-archiver +1. (simplest) via docker `docker ... TODO` +2. (pypi) `pip install auto-archiver` +3. (legacy) clone and manually install from repo (see legacy [tutorial video](https://youtu.be/VfAhcuV2tLQ)) + + + +### Examples + # Requirement configurations @@ -203,6 +213,7 @@ Archivers are tested in a meaningful order with Wayback Machine being the failsa > Note: We have 2 Twitter Archivers (`TwitterArchiver`, `TwitterApiArchiver`) because one requires Twitter API V2 credentials and has better results and the other does not rely on official APIs and misses out on some content. +https://mermaid.js.org/syntax/flowchart.html ```mermaid graph TD A(Archiver) -->|parent of| B(TelethonArchiver) diff --git a/scripts/release.sh b/scripts/release.sh new file mode 100755 index 0000000..b17093d --- /dev/null +++ b/scripts/release.sh @@ -0,0 +1,19 @@ + +#!/bin/bash + +set -e + +TAG=$(python -c 'from src.auto_archiver.version import VERSION; print("v" + VERSION)') + +read -p "Creating new release for $TAG. Do you want to continue? [Y/n] " prompt + +if [[ $prompt == "y" || $prompt == "Y" || $prompt == "yes" || $prompt == "Yes" ]]; then + git add -A + git commit -m "Bump version to $TAG for release" || true && git push + echo "Creating new git tag $TAG" + git tag "$TAG" -m "$TAG" + git push --tags +else + echo "Cancelled" + exit 1 +fi \ No newline at end of file diff --git a/src/auto_archiver/version.py b/src/auto_archiver/version.py new file mode 100644 index 0000000..91c42cd --- /dev/null +++ b/src/auto_archiver/version.py @@ -0,0 +1,12 @@ + +_MAJOR = "0" +_MINOR = "2" +# On main and in a nightly release the patch should be one ahead of the last +# released build. +_PATCH = "0" +# This is mainly for nightly builds which have the suffix ".dev$DATE". See +# https://semver.org/#is-v123-a-semantic-version for the semantics. +_SUFFIX = "" + +VERSION_SHORT = "{0}.{1}".format(_MAJOR, _MINOR) +VERSION = "{0}.{1}.{2}{3}".format(_MAJOR, _MINOR, _PATCH, _SUFFIX) \ No newline at end of file