external/iiab
1
0
Fork 0
mirror of https://github.com/iiab/iiab.git synced 2025-02-12 11:12:06 +00:00
Code Issues Releases Wiki Activity

Update roles-needing-docs.py

Browse source
This commit is contained in:
A Holt 2018-10-09 15:10:23 -04:00 committed by GitHub
parent f915b5ee22
commit 4b43f46530
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
scripts/roles-needing-docs.py
View file

@ -1,9 +1,9 @@
#!/usr/bin/env python3
'''
This script checks every role in the project and prints its name to stdout if
the role directory does not contain a README file and it is not listed in
scripts/docs-ignore.
This script checks every role in the (Internet-in-a-Box) project and prints its
name to stdout if (1) the role directory does not contain a README file, and
(2) the role is not listed in /opt/iiab/iiab/unmaintained-roles.txt
For ease of use, you can pipe the output of this script to a file or to a
clipboard utility (e.g. pbcopy on macOS, xclip on Linux).
@ -16,7 +16,9 @@ from glob import glob
def included_roles():
all_roles = set(os.listdir("/opt/iiab/iiab/roles"))
excluded_roles = \
map(str.rstrip, open(make_path("/opt/iiab/iiab/scripts", "/opt/iiab/iiab/scripts/docs-ignore")))
map(str.rstrip,
open(make_path("/opt/iiab/iiab/scripts",
"/opt/iiab/iiab/unmaintained-roles.txt")))
included_roles = list(all_roles.difference(excluded_roles))
included_roles.sort()
return included_roles