Update README.md
This commit is contained in:
parent
14bf4ed086
commit
017eec8f93
1 changed files with 27 additions and 1 deletions
28
README.md
28
README.md
|
|
@ -1,3 +1,29 @@
|
||||||
# Mastodon-archive-tool
|
# Mastodon-archive-tool
|
||||||
|
|
||||||
A small python script that will convert a Mastodon archive into a static HTML page where all old Mastodon posts can be viewed. See demo on https://arkiv.andersen.one.
|
A small python script that will convert a Mastodon archive into a static HTML page where all old Mastodon posts can be viewed. See demo on https://arkiv.andersen.one.
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
The purpose of this script was to create an archive of my old Mastodon profile, because I moved my profile to a new instance. The archive will include all posts, but not the comments or reboosts that has been made.
|
||||||
|
|
||||||
|
- An introduction with an avatar, name, Mastodon handle, introduction and number of posts, answers and quote posts.
|
||||||
|
- An information that the profile has been moved.
|
||||||
|
- All posts listed with newest first.
|
||||||
|
- A sidebar with search fields and filter buttons.
|
||||||
|
- Possible to filter only posts or answers, posts with pictures, links or tags, year or used tags.
|
||||||
|
|
||||||
|
## How to use
|
||||||
|
|
||||||
|
The python script must be in same folder as Mastodon archive, and the archive file must be named "Archive.zip". Run the scrupt in a Linux terminal with Python installed using the code 'python3 generate_archive.py'.
|
||||||
|
|
||||||
|
This will generate the static HTML page as index.html. The avatar will be in the same folder as avatar.png og media files will be included in the subfolder "media".
|
||||||
|
|
||||||
|
The language of the generated Mastodon archive is **danish**.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
The script is published under the GPL 3.0 license or later, which means you can use it and modify it for free.
|
||||||
|
|
||||||
|
## Follow me
|
||||||
|
|
||||||
|
Follow me on Mastodon on [@aphandersen@andersen.one](https://andersen.one/@aphandersen).
|
||||||
Loading…
Reference in a new issue