PonyMirrors/fimfarchive
1
0
Fork 0
mirror of https://github.com/JockeTF/fimfarchive.git synced 2024-11-22 05:17:59 +01:00
Code Issues Projects Releases Packages Wiki Activity
Mirror of https://github.com/JockeTF/fimfarchive
220 commits 14 branches 0 tags 443 KiB
Python 99.6%
HTML 0.3%
Dockerfile 0.1%
Find a file
Joakim Soderlund 49bd682c71 Add introduction section to readme
2021-01-27 16:24:58 +01:00
.github/workflows Migrate from Travis to GitHub Actions 2021-01-08 21:35:24 +01:00
docs Update readme for release 20201201 2020-11-28 17:35:34 +01:00
fimfarchive Fix string escape deprecation warning 2021-01-27 14:49:28 +01:00
operations Add Fimfarchive 20201201 to tracker whitelist 2020-11-28 22:32:30 +01:00
tests Fix deprecation warnings from Arrow 2021-01-08 20:03:11 +01:00
.coveragerc Add configuration file for test coverage 2017-01-09 00:10:16 +01:00
.gitignore Add vim settings to gitignore 2020-03-28 21:19:37 +01:00
LICENSE.txt Initial commit 2015-09-27 20:46:58 +02:00
README.md Add introduction section to readme 2021-01-27 16:24:58 +01:00
requirements.txt Sort dependencies in requirements file 2019-09-01 14:54:39 +02:00
setup.py Add JSON to FPUB converter 2019-03-10 15:16:50 +01:00
tox.ini Migrate from Travis to GitHub Actions 2021-01-08 21:35:24 +01:00

README.md

Fimfarchive

Fimfarchive aims to release all stories on Fimfiction as a single ZIP-file. The archive contains not only stories, but also metadata such as tags, ratings, and descriptions. It is organized by author and could be used for backup, offline reading, or data mining.

Releases can be found on Fimfarchive's user profile at Fimfiction. Note that this is not an official Fimfiction project, so do not send questions to Fimfiction staff. Instead, send a private message or post a comment to the Fimfarchive user profile.

A new version will be released each season via BitTorrent, approximately once every three months. When suitable, an xdelta3 patch will also be provided for users who do not wish to redownload unchanged stories.

Note that the archive contains a large number of files. Unzipping it to your file system may not be necessary if the archive is to be used together with some application. If you are a developer, reading directly from the ZIP-file may be preferable.

This repository contains the code for updating and building the archive. While the API is not guaranteed to be stable, it can also be used as a library for easy access to stories and metadata within the archive.