You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Hans-Christoph Steiner 42cb31039e Merge branch 'fix_status_deploy' into 'master' 5 hours ago
.vscode fix vscode setting 1 year ago
buildserver buildserver: default to HTTPS for apt sources 3 weeks ago
completion bash-completion: complete *.apk files for `fdroid signatures` 1 year ago
docs Publish docu to GL Pages 1 year ago
examples mirror-to-mirror.sh: replace mirror.f-droid.org with ftp.agdsn.de 5 months ago
fdroidserver Sync all status files 6 hours ago
hooks ignore E203 for black 1 year ago
locale make -C locale/ update 3 weeks ago
tests Add test for git getref 2 weeks ago
.bandit add vscode settings 1 year ago
.editorconfig Add .editorconfig 1 week ago
.gitignore scanner: add some rules 2 weeks ago
.gitlab-ci.yml Work around old apksigner on f-droid.org publish server 1 week ago
.pylint-rcfile Make lint max-line-length to 88 for black 1 year ago
.travis.yml travis-ci: Calling brew cask install is disabled! Use brew install [--cask] instead 2 years ago
.weblate add weblate config for wlc CLI tool 3 years ago
CHANGELOG.md update CHANGELOG 1 year ago
LICENSE Rename COPYING to LICENSE 7 years ago
MANIFEST.in enable Czech as official language 3 weeks ago
README.md Update README.md 1 year ago
fdroid fix tests on old python version 3 years ago
gradlew-fdroid gradle v7.5.1 2 months ago
jenkins-build-all Drop code for the old wiki 10 months ago
jenkins-setup-build-environment init: switch to config.yml as the default format 2 years ago
jenkins-test jenkins-test: remove checkupdates; jenkins admins need short jobs 2 years ago
makebuildserver Merge comparisons with 'in' 3 weeks ago
mypy.ini add vscode settings 1 year ago
pyproject.toml add vscode settings 1 year ago
setup.cfg stop compiling locale files for the sdist tarballs 8 months ago
setup.py version 2.1 7 months ago

README.md

F-Droid Server

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.

For documentation, please see https://f-droid.org/docs, or you can
find the source for the documentation in
fdroid/fdroid-website.

CI/CD status

fdroidserver buildserver fdroid build --all publishing tools
GNU/Linux fdroidserver status on GNU/Linux buildserver status fdroid build all status fdroid test status
macOS fdroidserver status on macOS

Installing

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.

Tests

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.

fdroid commands

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
various configurations.

  • tests/run-tests runs the whole test suite
  • tests/*.TestCase are individual unit tests for all of the fdroid
    commands, which can be run separately, e.g. ./update.TestCase.
  • run one test: tests/common.TestCase CommonTest.test_get_apk_id

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
.gitlab-ci.yml

and push this to a new branch of your fork.

Alternatively run them
locally

like this: gitlab-runner exec docker ubuntu_lts

Buildserver

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.

Documentation

The API documentation based on the docstrings gets automatically
published here on every commit
on the master branch.

It can be built locally via

pip install -e .[docs]
cd docs
sphinx-apidoc -o ./source ../fdroidserver -M -e
sphinx-autogen -o generated source/*.rst   
make html

To additionally lint the code call

pydocstyle fdroidserver --count

When writing docstrings you should follow the
numpy style guide.

Translation

Everything can be translated. See
Translation and Localization
for more info.

View translation status for all languages.