mirror of
https://github.com/YunoHost/yunodevtools.git
synced 2024-09-03 20:16:19 +02:00
commit
3ed555bc5a
2 changed files with 63 additions and 35 deletions
24
README.md
24
README.md
|
@ -1,12 +1,12 @@
|
||||||
# YunoHost apps directory
|
# YunoHost apps directory
|
||||||
|
|
||||||
<img src="https://yunohost.org/logo.png" width=80>
|
<img src="https://yunohost.org/logo.png" width=80>
|
||||||
|
|
||||||

|

|
||||||

|

|
||||||

|

|
||||||

|

|
||||||

|

|
||||||
|
|
||||||
<img src="https://yunohost.org/images/freshrss_logo.png" width=60>
|
<img src="https://yunohost.org/images/freshrss_logo.png" width=60>
|
||||||
<img src="https://yunohost.org/images/Icons_mumble.svg" width=60>
|
<img src="https://yunohost.org/images/Icons_mumble.svg" width=60>
|
||||||
<img src="https://yunohost.org/images/Lutim_small.png" width=50>
|
<img src="https://yunohost.org/images/Lutim_small.png" width=50>
|
||||||
|
@ -35,8 +35,6 @@ sudo yunohost app fetchlist -n community -u https://yunohost.org/community.json
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
#### How to add your app to the community list
|
#### How to add your app to the community list
|
||||||
|
|
||||||
* Fork and edit the [community list](https://github.com/YunoHost/apps/tree/master/community.json)
|
* Fork and edit the [community list](https://github.com/YunoHost/apps/tree/master/community.json)
|
||||||
|
@ -54,26 +52,6 @@ App example addition:
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
#### How to propose your app to be integrated in the official applications list
|
|
||||||
|
|
||||||
Here is the procedure to request that your app will be part of the list of official applications of YunoHost:
|
|
||||||
|
|
||||||
* before everything, having you application joining the list of official applications will make you a maintainer of it and will requires you to ensure this position or to find someone else to do it in the future
|
|
||||||
* your app must be tested on several architectures (32/64 bits, ARM) or depends on cross-platform systems
|
|
||||||
* you must be subscribed to the [apps official mailing list](https://list.yunohost.org/cgi-bin/mailman/listinfo/apps) since this is the way that we communicate to apps maintainers
|
|
||||||
* your application package must have the following scripts:
|
|
||||||
* a install script, obviously
|
|
||||||
* a remove script
|
|
||||||
* an upgrade script if needed
|
|
||||||
* a backup/restore script if your application stores data
|
|
||||||
* your application must be installable on a custom path (`domain.tld/custom_path/`) in addition to the root path (`some.domain.tld/`)
|
|
||||||
* if relevant, your application must be integrated with YunoHost SSO
|
|
||||||
* the application you have packaged must be free software, as in free speech
|
|
||||||
* once all those requirements are fulfilled, fork this repository, add your application to the official.json list with the status "validated" following the documentation above, then open a pull request
|
|
||||||
* we will then start a reviewing process and we will work together to bring your application to a state where we can hopefully include it to the official applications list :)
|
|
||||||
|
|
||||||
Since our documentation regarding all those part is not as complete as it should be, don't hesitate to ask questions on the [apps mailing list](https://list.yunohost.org/cgi-bin/mailman/listinfo/apps) regarding those points.
|
|
||||||
|
|
||||||
#### Helper script
|
#### Helper script
|
||||||
|
|
||||||
You can use the <code>add_or_update.py</code> python script to add or update
|
You can use the <code>add_or_update.py</code> python script to add or update
|
||||||
|
|
|
@ -11,7 +11,7 @@ import requests
|
||||||
from dateutil.parser import parse
|
from dateutil.parser import parse
|
||||||
|
|
||||||
|
|
||||||
## Regular expression patterns
|
# Regular expression patterns
|
||||||
|
|
||||||
"""GitHub repository URL."""
|
"""GitHub repository URL."""
|
||||||
re_github_repo = re.compile(
|
re_github_repo = re.compile(
|
||||||
|
@ -24,7 +24,7 @@ re_commit_author = re.compile(
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
## Helpers
|
# Helpers
|
||||||
|
|
||||||
def fail(msg, retcode=1):
|
def fail(msg, retcode=1):
|
||||||
"""Show failure message and exit."""
|
"""Show failure message and exit."""
|
||||||
|
@ -32,7 +32,37 @@ def fail(msg, retcode=1):
|
||||||
sys.exit(retcode)
|
sys.exit(retcode)
|
||||||
|
|
||||||
|
|
||||||
## Main
|
def include_translations_in_manifest(app_name, manifest):
|
||||||
|
for i in os.listdir("locales"):
|
||||||
|
if not i.endswith("json"):
|
||||||
|
continue
|
||||||
|
|
||||||
|
if i == "en.json":
|
||||||
|
continue
|
||||||
|
|
||||||
|
current_lang = i.split(".")[0]
|
||||||
|
translations = json.load(open(os.path.join("locales", i), "r"))
|
||||||
|
|
||||||
|
key = "%s_manifest_description" % app_name
|
||||||
|
if key in translations and translations[key]:
|
||||||
|
manifest["description"][current_lang] = translations[key]
|
||||||
|
|
||||||
|
for category, questions in manifest["arguments"].items():
|
||||||
|
for question in questions:
|
||||||
|
key = "%s_manifest_arguments_%s_%s" % (app_name, category, question["name"])
|
||||||
|
if key in translations and translations[key]:
|
||||||
|
print "[ask]", current_lang, key
|
||||||
|
question["ask"][current_lang] = translations[key]
|
||||||
|
|
||||||
|
key = "%s_manifest_arguments_%s_help_%s" % (app_name, category, question["name"])
|
||||||
|
if key in translations and translations[key]:
|
||||||
|
print "[help]", current_lang, key
|
||||||
|
question["help"][current_lang] = translations[key]
|
||||||
|
|
||||||
|
return manifest
|
||||||
|
|
||||||
|
|
||||||
|
# Main
|
||||||
|
|
||||||
# Create argument parser
|
# Create argument parser
|
||||||
parser = argparse.ArgumentParser(description='Process YunoHost application list.')
|
parser = argparse.ArgumentParser(description='Process YunoHost application list.')
|
||||||
|
@ -81,23 +111,41 @@ for app, info in apps_list.items():
|
||||||
# Store usefull values
|
# Store usefull values
|
||||||
app_url = info['url']
|
app_url = info['url']
|
||||||
app_rev = info['revision']
|
app_rev = info['revision']
|
||||||
|
app_state = info["state"]
|
||||||
|
app_level = info.get("level")
|
||||||
|
|
||||||
|
previous_state = already_built_file.get(app, {}).get("state", {})
|
||||||
|
|
||||||
manifest = {}
|
manifest = {}
|
||||||
timestamp = None
|
timestamp = None
|
||||||
|
|
||||||
if already_built_file.get(app, {}).get("git", {}).get("revision", None) == app_rev and already_built_file.get(app, {}).get("git", {}).get("url") == app_url:
|
previous_rev = already_built_file.get(app, {}).get("git", {}).get("revision", None)
|
||||||
|
previous_url = already_built_file.get(app, {}).get("git", {}).get("url")
|
||||||
|
previous_level = already_built_file.get(app, {}).get("level")
|
||||||
|
|
||||||
|
if previous_rev == app_rev and previous_url == app_url:
|
||||||
print("%s[%s] is already up to date in target output, ignore" % (app, app_rev))
|
print("%s[%s] is already up to date in target output, ignore" % (app, app_rev))
|
||||||
result_dict[app] = already_built_file[app]
|
result_dict[app] = already_built_file[app]
|
||||||
|
if previous_state != app_state:
|
||||||
|
result_dict[app]["state"] = app_state
|
||||||
|
print("... but has changed of state, updating it from '%s' to '%s'" % (previous_state, app_state))
|
||||||
|
if previous_level != app_level or app_level is None:
|
||||||
|
result_dict[app]["level"] = app_level
|
||||||
|
print("... but has changed of level, updating it from '%s' to '%s'" % (previous_level, app_level))
|
||||||
|
|
||||||
|
print "update translations but don't download anything"
|
||||||
|
result_dict[app]['manifest'] = include_translations_in_manifest(app, result_dict[app]['manifest'])
|
||||||
|
|
||||||
continue
|
continue
|
||||||
|
|
||||||
## Hosted on GitHub
|
# Hosted on GitHub
|
||||||
github_repo = re_github_repo.match(app_url)
|
github_repo = re_github_repo.match(app_url)
|
||||||
if github_repo:
|
if github_repo:
|
||||||
owner = github_repo.group('owner')
|
owner = github_repo.group('owner')
|
||||||
repo = github_repo.group('repo')
|
repo = github_repo.group('repo')
|
||||||
|
|
||||||
raw_url = 'https://raw.githubusercontent.com/%s/%s/%s/manifest.json' % (
|
raw_url = 'https://raw.githubusercontent.com/%s/%s/%s/manifest.json' % (
|
||||||
owner, repo, app_rev
|
owner, repo, app_rev
|
||||||
)
|
)
|
||||||
try:
|
try:
|
||||||
# Retrieve and load manifest
|
# Retrieve and load manifest
|
||||||
|
@ -112,7 +160,7 @@ for app, info in apps_list.items():
|
||||||
continue
|
continue
|
||||||
|
|
||||||
api_url = 'https://api.github.com/repos/%s/%s/commits/%s' % (
|
api_url = 'https://api.github.com/repos/%s/%s/commits/%s' % (
|
||||||
owner, repo, app_rev
|
owner, repo, app_rev
|
||||||
)
|
)
|
||||||
try:
|
try:
|
||||||
# Retrieve last commit information
|
# Retrieve last commit information
|
||||||
|
@ -128,7 +176,8 @@ for app, info in apps_list.items():
|
||||||
else:
|
else:
|
||||||
commit_date = parse(info2['commit']['author']['date'])
|
commit_date = parse(info2['commit']['author']['date'])
|
||||||
timestamp = int(time.mktime(commit_date.timetuple()))
|
timestamp = int(time.mktime(commit_date.timetuple()))
|
||||||
## Git repository with HTTP/HTTPS (Gogs, GitLab, ...)
|
|
||||||
|
# Git repository with HTTP/HTTPS (Gogs, GitLab, ...)
|
||||||
elif app_url.startswith('http') and app_url.endswith('.git'):
|
elif app_url.startswith('http') and app_url.endswith('.git'):
|
||||||
raw_url = '%s/raw/%s/manifest.json' % (app_url[:-4], app_rev)
|
raw_url = '%s/raw/%s/manifest.json' % (app_url[:-4], app_rev)
|
||||||
try:
|
try:
|
||||||
|
@ -144,7 +193,7 @@ for app, info in apps_list.items():
|
||||||
continue
|
continue
|
||||||
|
|
||||||
obj_url = '%s/objects/%s/%s' % (
|
obj_url = '%s/objects/%s/%s' % (
|
||||||
app_url, app_rev[0:2], app_rev[2:]
|
app_url, app_rev[0:2], app_rev[2:]
|
||||||
)
|
)
|
||||||
try:
|
try:
|
||||||
# Retrieve last commit information
|
# Retrieve last commit information
|
||||||
|
@ -191,15 +240,16 @@ for app, info in apps_list.items():
|
||||||
'url': app_url
|
'url': app_url
|
||||||
},
|
},
|
||||||
'lastUpdate': timestamp,
|
'lastUpdate': timestamp,
|
||||||
'manifest': manifest,
|
'manifest': include_translations_in_manifest(manifest['id'], manifest),
|
||||||
'state': info['state']
|
'state': info['state'],
|
||||||
|
'level': info.get('level', '?')
|
||||||
}
|
}
|
||||||
except KeyError as e:
|
except KeyError as e:
|
||||||
print("-> Error: invalid app info or manifest, %s" % e)
|
print("-> Error: invalid app info or manifest, %s" % e)
|
||||||
continue
|
continue
|
||||||
|
|
||||||
# Write resulting file
|
# Write resulting file
|
||||||
with open(args.output , 'w') as f:
|
with open(args.output, 'w') as f:
|
||||||
f.write(json.dumps(result_dict, sort_keys=True))
|
f.write(json.dumps(result_dict, sort_keys=True))
|
||||||
|
|
||||||
print("\nDone! Written in %s" % args.output)
|
print("\nDone! Written in %s" % args.output)
|
||||||
|
|
Loading…
Add table
Reference in a new issue