Tree @master (Download .tar.gz)
yastasoti
Version 0.4 | Entry @ catseye.tc | See also: ellsync ∘ tagfarm ∘ shelf
Yet another script to archive stuff off teh internets.
It's not a spider that automatically crawls previously undiscovered webpages — it's intended to be run by a human to make backups of resources they have already seen and recorded the URLs of.
It was split off from Feedmark, which doesn't itself need to support this function.
Features
- input is a JSON list of objects containing links (such as those produced by Feedmark)
- output is a JSON list of objects that could not be retrieved, which can be fed back into the script as input
- checks links with
HEAD
requests by default.--archive-to
causes each link to be fetched withGET
and saved to the specified directory.--archive-via
specifies an archive router which causes each link to be fetched, and saved to a directory which is selected based on the URL of the link. - tries to be idempotent and not create a new local file if the remote file hasn't changed
- handles links that are local files; checks if the file exists locally
- can log its actions verbosely to a specified logfile
- source code is a single, public-domain file with a single dependency (
requests
)
Examples
Check all links in a set of Feedmark documents
feedmark --output-links article/*.md | yastasoti --extant-path=article/ - | tee results.json
This will make only HEAD
requests to check that the resources exist.
It will not fetch them. The ones that could not be fetches will appear
in results.json
, and you can run yastasoti on that again to re-try:
yastasoti --extant-path=article/ results.json | tee results2.json
Archive stuff off teh internets
cat >links.json << EOF
[
{
"url": "http://catseye.tc/"
}
]
EOF
yastasoti --archive-to=downloads links.json
Override the filename the stuff is archived as
By default, the subdirectory and filename to which the stuff is archived are
based on the site's domain name and the stuff's path. The filename, however,
can be overridden if the input JSON contains a dest_filename
field.
cat >links.json << EOF
[
{
"url": "http://catseye.tc/",
"dest_filename": "home_page.html"
}
]
EOF
yastasoti --archive-to=downloads links.json
Categorize archived materials with a router
An archive router (used with --archive-via
) is a JSON file that looks like this:
{
"http://catseye.tc/*": "/dev/null",
"https://footu.be/*": "footube/",
"*": "archive/"
}
If a URL matches more than one pattern, the longest pattern will be selected.
If the destination is /dev/null
it will be treated specially — the file will
not be retrieved at all. If no pattern matches, an error will be raised.
To use an archive router once it has been written:
yastasoti --archive-via=router.json links.json
Requirements
Tested under Python 2.7.12. Seems to work under Python 3.5.2 as well, but this is not so official.
Requires requests
Python library to make network requests. Tested
with requests
version 2.21.0.
If tqdm
Python library is installed, will display a nice progress bar.
(Or, if you would like to use Docker, you can pull a Docker image from catseye/yastasoti on Docker Hub, following the instructions given on that page.)
TODO
- Archive youtube links with youtube-dl.
- Handle failures (redirects, etc) better (detect 503 / "connection refused" better.)
- Allow use of an external tool like
wget
orcurl
to do fetching.
Commit History
@master
git clone https://git.catseye.tc/yastasoti/
- Arrange licensing info in repo according to REUSE 3.2 convention. Chris Pressey a month ago
- Merge branch 'master' of https://codeberg.org/catseye/yastasoti Chris Pressey 11 months ago
- Update links in "see-also bar". Chris Pressey 11 months ago
- Merge pull request #3 from catseye/dependabot/pip/requests-2.31.0 Chris Pressey (commit: GitHub) 1 year, 4 months ago
- Bump requests from 2.21.0 to 2.31.0 dependabot[bot] (commit: GitHub) 1 year, 4 months ago
- Minor updates to README. Chris Pressey (commit: GitHub) 4 years ago
- Add link to tagfarm in README. Chris Pressey (commit: GitHub) 4 years ago
- Update README. Chris Pressey 4 years ago
- Put bind mount at /mnt/host inside the Docker container, use PATH. Chris Pressey 5 years ago
- Add Dockerfile for building yastasoti docker image. Chris Pressey 5 years ago