F-Droid Server Tools
Server tools for maintaining an F-Droid repository system.
What is F-Droid?
F-Droid is an installable catalogue of FOSS (Free and Open Source Software) applications for the Android platform. The client makes it easy to browse, install, and keep track of updates on your device.
What is F-Droid Server?
The F-Droid server tools provide various scripts and tools that are used to maintain the main F-Droid application repository. You can use these same tools to create your own additional or alternative repository for publishing, or to assist in creating, testing and submitting metadata to the main repository.
There are many ways to install fdroidserver, they are documented on the website: https://f-droid.org/docs/Installing_the_Server_and_Repo_Tools
All sorts of other documentation lives there as well.
There are many components to all the tests for the components in this git repository. The most commonly used parts of well tested, while some parts still lack tests. This test suite has built over time a bit haphazardly, so it is not as clean, organized, or complete as it could be. We welcome contributions. Before rearchitecting any parts of it, be sure to contact us to discuss the changes beforehand.
The test suite for all of the
fdroid commands is in the tests/
subdir. .gitlab-ci.yml and .travis.yml run this test suite on
- tests/run-tests runs the whole test suite
- tests/*.TestCase are individual unit tests for all of the
fdroidcommands, which can be run separately, e.g.
- run one test:
Additional tests for different linux distributions
These tests are also run on various distributions through GitLab CI. This is
only enabled for
master@fdroid/fdroidserver because it takes longer to
complete than the regular CI tests. Most of the time you won't need to worry
about them, but sometimes it might make sense to also run them for your merge
request. In that case you need to remove these lines from
and push this to a new branch of your fork.
Alternatively run them
gitlab-runner exec docker ubuntu_lts
The tests for the whole build server setup are entirely separate because they require at least 200 GB of disk space, and 8 GB of RAM. These test scripts are in the root of the project, all starting with jenkins- since they are run on https://jenkins.debian.net.
The API documentation based on the docstrings gets automatically
published here on every commit
It can be built locally via
pip install -e .[docs]
sphinx-apidoc -o ./source ../fdroidserver -M -e
sphinx-autogen -o generated source/*.rst
To additionally lint the code call
pydocstyle fdroidserver --count
When writing docstrings you should follow the numpy style guide.
Everything can be translated. See Translation and Localization for more info.
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.