fdroid-dl is a f-droid (offline) mirror generation and update utility
Project description
fdroid-dl
Is a python based f-droid mirror generation and update utility. Point at one or more existing f-droid repositories and the utility will download the metadata (pictures, descriptions,..) for you and place it in your local system. Simply run fdroid-dl && fdroid update
and you are set.
Motivation
The idea is to have an no internet local copy of one or more repositories, without the need to compile the thousands of apps on your own build server but rather download them like the android client does. So this tool came into existence to simply download a while repository and import the apps into your own locally installed one. At the time of writing a full offline copy including assets is ~7.5GB of the official repository of f-droid.org.
Installation
fdroid-dl is available via pip, simply run pip install fdroid-dl
and you can use fdroid-dl
on your command line.
Documentation
Can be found at fdroid-dl.readthedocs.io
Command Line Options
Configuration File
TODO
- Create backend to crawl existing repos
- Fetch info directly index.jar and index-v1.jar
- Compatibility with old and new repo styles
- Download multi threaded
- Verify apk checksum
- Local cache for index files
- Source code download not implemented yet
- Metadata update to do delta not full download all the time
- Cleanup strategy for old apk files (maybe
fdroid update
does this already?) - Create a CLI python click
- pip package packaging.python.org
- CI builds for pip package
- Documentation ;-)
- Writing tests pytest
CHANGELOG
- WIP: Documentation added
- WIP: Test added
- requests-mock ?
Ideas
- requests-cache ?
Development
Requirements
- python 3.x
- pip 3.x
- virtualenv 3.x
install locally
# git clone https://github.com/t4skforce/fdroid-dl.git
# cd fdroid-dl
# virtualenv .env
# source .env/bin/activate
# python setup.py install
# fdroid-dl --help
References
While this project was developed the following references where used
F-Droid
- Setup an F-Droid App Repo f-droid.org
- Build Metadata Reference f-droid.org
- All About Descriptions, Graphics, and Screenshots f-droid.org
- How to Add a Repo to F-Droid f-droid.org
- How to Send and Receive Apps Offline f-droid.org
Python
- Python Documentation python.org
- PyYAML Documentation pyyaml.org
- Requests: HTTP for Humans python-requests.org
- Suppress InsecureRequestWarning: Unverified HTTPS request is being made in Python2.6 stackoverflow.com
- How to download large file in python with requests.py? stackoverflow.com
- Asynchronous Python HTTP Requests for Humans using Futures requests-futures
- Testing Your Code python-guide.org
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for fdroid_dl-0.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | de010fe25ea9ce3d682a9fc13c3ced4256518589ce72e84b9bf6c2bafd13c8a2 |
|
MD5 | 1196064ab0d704179d43fe791670fc50 |
|
BLAKE2b-256 | 1a8fda516109f7d63b3c126c1d19917015d6dca628541d78c352e3728283e646 |