xdcget 0.2.3

experimental tool for collecting latest releases of webxdc apps

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

1. Install xdcget command line tool from a local checkout:

    pip install -e . 
   

2. Initialize config files:

    xdcget init 
   

3. Edit xdcget.ini to contain your Codeberg and Github API access token (see below) and also adjust config options as needed.

4. Edit sources.ini to modify the list of source repositories.

5. Run the update command to cache all releases for repositories listed in sources.ini:

    xdcget update 
   

6. Run the export command to create files for xdcstore 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> 

Building and publishing xdcget releases (maintainer notes)

This project uses a single pyproject.toml to define all python build/test metadata. See Packaging Python Projects for more details.

Quick notes on requirements for releasing:

• pip install build twine for building and uploading distribution files

• python -m build to build the distribution files

• create API-tokens on PyPI to be able to upload to PyPI repositories.

• twine upload dist/* to upload all built distribution files