Add docs and remove unused import

This commit is contained in:
decentral1se 2021-04-02 16:05:31 +02:00
parent 0323fbe1c8
commit 75af48bc5d
Signed by untrusted user who does not match committer: decentral1se
GPG Key ID: 92DAD76BD9567B8A
2 changed files with 16 additions and 1 deletions

View File

@ -59,6 +59,15 @@ The command-line interface is generated via [docopt](http://docopt.org/). If you
Please remember to update the [CHANGELOG](./CHANGELOG.md) when you make a change. Please remember to update the [CHANGELOG](./CHANGELOG.md) when you make a change.
## Generating a new abra-apps.json
You'll need to install the following requirements:
- [requests](https://docs.python-requests.org/en/master/) (`apt install python3-requests` / `pip install requests`)
- [skopeo](https://github.com/containers/skopeo) (check the [install docs](https://github.com/containers/skopeo/blob/master/install.md))
Then run `./bin/app-json.py` ([source](./bin/app-json.py)) and it will spit out the JSON file into [deploy/abra-apps.autonomic.zone/abra-apps.json](./deploy/abra-apps.autonomic.zone/abra-apps.json).
## Releasing ## Releasing
### `abra` ### `abra`

View File

@ -1,7 +1,13 @@
#!/usr/bin/env python3 #!/usr/bin/env python3
# Usage: ./app-json.py
#
# Gather metadata from Co-op Cloud apps in $ABRA_DIR/apps (default
# ~/.abra/apps), and format it as JSON so that it can be hosted here:
# https://abra-apps.autonomic.zone
from json import dump from json import dump
from os import chdir, getcwd, listdir, mkdir from os import chdir, listdir, mkdir
from os.path import exists, expanduser from os.path import exists, expanduser
from pathlib import Path from pathlib import Path
from re import findall, search from re import findall, search