This repository has been archived by the owner on May 16, 2024. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 268
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
103 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,103 @@ | ||
#!/usr/bin/env python | ||
from __future__ import print_function | ||
import ast | ||
import os | ||
import re | ||
|
||
|
||
MARKERS = r'(\[//\]: # \(addons\))|(\[//\]: # \(end addons\))' | ||
|
||
|
||
class UserError(Exception): | ||
def __init__(self, msg): | ||
self.msg = msg | ||
|
||
|
||
def sanitize_cell(s): | ||
if not s: | ||
return '' | ||
s = ' '.join(s.split()) | ||
return s | ||
|
||
|
||
def render_markdown_table(header, rows): | ||
table = [] | ||
rows = [header, ['---'] * len(header)] + rows | ||
for row in rows: | ||
table.append(' | '.join(row)) | ||
return '\n'.join(table) | ||
|
||
|
||
def replace_in_readme(readme_path, header, rows_available, rows_unported): | ||
readme = open(readme_path).read() | ||
parts = re.split(MARKERS, readme, flags=re.MULTILINE) | ||
if len(parts) != 7: | ||
raise UserError('Addons markers not found or incorrect in %s' % | ||
readme_path) | ||
addons = [] | ||
if rows_available: | ||
addons.extend([ | ||
'\n', | ||
'Available addons\n', | ||
'----------------\n', | ||
render_markdown_table(header, rows_available), | ||
'\n' | ||
]) | ||
if rows_unported: | ||
addons.extend([ | ||
'\n', | ||
'Unported addons\n', | ||
'---------------\n', | ||
render_markdown_table(header, rows_unported), | ||
'\n' | ||
]) | ||
parts[2:5] = addons | ||
readme = ''.join(parts) | ||
open(readme_path, 'w').write(readme) | ||
|
||
|
||
def gen_addons_table(): | ||
readme_path = 'README.md' | ||
if not os.path.isfile(readme_path): | ||
raise UserError('%s not found' % readme_path) | ||
# list addons in . and __unported__ | ||
addon_paths = [] # list of (addon_path, unported) | ||
for addon_path in os.listdir('.'): | ||
addon_paths.append((addon_path, False)) | ||
unported_directory = '__unported__' | ||
if os.path.isdir(unported_directory): | ||
for addon_path in os.listdir(unported_directory): | ||
addon_path = os.path.join(unported_directory, addon_path) | ||
addon_paths.append((addon_path, True)) | ||
addon_paths = sorted(addon_paths, lambda x, y: cmp(x[0], y[0])) | ||
# load manifests | ||
header = ('addon', 'version', 'summary') | ||
rows_available = [] | ||
rows_unported = [] | ||
for addon_path, unported in addon_paths: | ||
manifest_path = os.path.join(addon_path, '__openerp__.py') | ||
if os.path.isfile(manifest_path): | ||
manifest = ast.literal_eval(open(manifest_path).read()) | ||
addon_name = os.path.basename(addon_path) | ||
link = '[%s](%s/)' % (addon_name, addon_path) | ||
version = manifest.get('version') or '' | ||
summary = manifest.get('summary') or manifest.get('name') | ||
summary = sanitize_cell(summary) | ||
installable = manifest.get('installable', True) | ||
if unported and installable: | ||
raise UserError('%s is in __unported__ but is marked ' | ||
'installable.' % addon_path) | ||
if installable: | ||
rows_available.append((link, version, summary)) | ||
else: | ||
rows_unported.append((link, version + ' (unported)', summary)) | ||
# replace table in README.md | ||
replace_in_readme(readme_path, header, rows_available, rows_unported) | ||
|
||
|
||
if __name__ == '__main__': | ||
try: | ||
gen_addons_table() | ||
except UserError as e: | ||
print(e.msg) | ||
exit(1) |