-
Notifications
You must be signed in to change notification settings - Fork 0
/
createreadme.py
executable file
·113 lines (89 loc) · 3.35 KB
/
createreadme.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
import os
HEADER = '''# T I L
> Today-I-Learned Repository
This is my 'Today-I-Learned' repository which is used to keep a record of whatever I learn in daily basis.
'''
FOOTER = '''## Details
Want to know more about TIL repositories, see [Details.md](https://github.com/Pranav-Khurana/TIL/blob/master/Details.md)
'''
''' Walk the current directory and get a list of all subdirectories at that
level. These are the "categories" in which there are TILs. '''
def get_category_list ():
dirs = [x for x in os.listdir ('.') if os.path.isdir (x) and '.git' not in x]
return dirs
''' Read the file until we hit the first line that starts with a #
indicating a title in markdown. We'll use that as the title for this
entry. '''
def get_title (til_file):
with open (til_file) as file:
for line in file:
line = line.strip ()
if line.startswith ('#'):
return line[1:].lstrip () # text after # and whitespace
''' For a given category, get the list of TIL titles. '''
def get_tils (category):
til_files = [x for x in os.listdir (category)]
titles = []
for filename in til_files:
fullname = os.path.join (category, filename)
if (os.path.isfile (fullname)) and fullname.endswith ('.md'):
title = get_title (fullname)
# changing path separator for Windows paths
# https://mail.python.org/pipermail/tutor/2011-July/084788.html
titles.append ((title, fullname.replace (os.path.sep, '/')))
return titles
def get_category_dict (category_names):
categories = {}
count = 0
for category in category_names:
titles = get_tils (category)
categories[category] = titles
count += len (titles)
return (count, categories)
''' Now we have all the information, print it out in markdown format. '''
def print_file (category_names, categories):
with open ('README.md', 'w') as file:
file.write (HEADER)
file.write ('''
---
## Categories
''')
# print the list of categories with links
for category in sorted (category_names):
file.write ('* [{0}](#{1})\n'.format (category.capitalize (), category))
if len (category_names) > 0:
file.write ('''
---
''')
# print the section for each category
for category in sorted (category_names):
file.write ('### {0}\n'.format (category.capitalize ()))
file.write ('\n')
tils = categories[category]
for (title, filename) in sorted (tils):
file.write ('- [{0}]({1})\n'.format (title, filename))
file.write ('\n')
if len (category_names) > 0:
file.write ('''
---
''')
file.write (FOOTER)
def print_BADGE (til):
with open ('badges.json', 'w') as file:
st = '{ "total_til" : ' + str(til) + '}'
file.write('{0}'.format(st))
''' Create a TIL README.md file with a nice index for using it directly
from GitHub. '''
def create_README ():
category_names = get_category_list ()
count, categories = get_category_dict (category_names)
print_BADGE(count)
print_file (category_names, categories)
if __name__ == '__main__':
create_README ()
os.system('git add README.md')
os.system('git add badges.json')