experimental tool for collecting latest releases of webxdc apps
Project description
xdcget: a command line tool to collect webxdc apps from git repositories
The "xdcget" command line tool collects WebXDC apps via the release API of Codeberg and Github. The main purpose for this tool is to maintain a cache of released webxdc apps and to export release files so they can be imported from the WebXDC Store which in turn can be used by Delta Chat users to discover webxdc apps for sharing in chats.
Getting started
-
Install
xdcget
command line tool from a local checkout:pip install -e .
-
Initialize config files:
xdcget init
-
Edit
xdcget.ini
to contain your Codeberg and Github API access token (see below) and also adjust config options as needed. -
Edit
sources.ini
to modify the list of source repositories. -
Run the
update
command to cache all releases for repositories listed insources.ini
:xdcget update
-
Run the
export
command to create files forxdcstore import <PATH>
xdcget export
Getting a Codeberg API access token
Login with Codeberg and open https://codeberg.org/user/settings/applications
to generate a new token. This token does not need any special "scopes"
it's only used for querying releases of public repositories.
You can copy the resulting API token into your clipboard
and then insert it into the config file:
# the line you need to put into `xdcget.ini`
CODEBERG_USER = <your-codeberg-user-name>
CODEBERG_TOKEN = <paste-your-codeberg-access-token-here>
Getting a Github API access token
Login with github and open https://github.com/settings/tokens to generate a new token. This token does not need any access to your private repos -- it's only used for querying releases of public repositories. You may give it 90 days or other expiration times as you feel fine with. You can copy the resulting API token into your clipboard and then insert it into the config file:
# the line you need to put into `xdcget.ini`
GITHUB_USER = <your-github-user-name>
GITHUB_TOKEN = <paste-your-github-access-token-here>
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.