Mercurial > mozilla > hg > DocumentIt
annotate document_it.py @ 22:67e4becc7d49
first steps for cleaning up this awful mess
author | Jeff Hammel <jhammel@mozilla.com> |
---|---|
date | Wed, 03 Aug 2011 10:58:45 -0700 |
parents | 7299c4529b41 |
children | e6ed732e8ce6 |
rev | line source |
---|---|
0 | 1 #!/usr/bin/env python |
2 | |
3 """ | |
9 | 4 update MDN documentation from markdown |
4
550f4b240e20
make almost look like what we want to do
Jeff Hammel <jhammel@mozilla.com>
parents:
2
diff
changeset
|
5 |
550f4b240e20
make almost look like what we want to do
Jeff Hammel <jhammel@mozilla.com>
parents:
2
diff
changeset
|
6 see: |
550f4b240e20
make almost look like what we want to do
Jeff Hammel <jhammel@mozilla.com>
parents:
2
diff
changeset
|
7 http://developer.mindtouch.com/en/ref/MindTouch_API/POST%3Apages%2F%2F%7Bpageid%7D%2F%2Fcontents |
550f4b240e20
make almost look like what we want to do
Jeff Hammel <jhammel@mozilla.com>
parents:
2
diff
changeset
|
8 |
550f4b240e20
make almost look like what we want to do
Jeff Hammel <jhammel@mozilla.com>
parents:
2
diff
changeset
|
9 The manifest format is in the form: |
550f4b240e20
make almost look like what we want to do
Jeff Hammel <jhammel@mozilla.com>
parents:
2
diff
changeset
|
10 |
550f4b240e20
make almost look like what we want to do
Jeff Hammel <jhammel@mozilla.com>
parents:
2
diff
changeset
|
11 mozrunner/README.txt https://developer.mozilla.org/en/Mozrunner |
550f4b240e20
make almost look like what we want to do
Jeff Hammel <jhammel@mozilla.com>
parents:
2
diff
changeset
|
12 jsbridge/README.txt https://developer.mozilla.org/en/JSbridge |
550f4b240e20
make almost look like what we want to do
Jeff Hammel <jhammel@mozilla.com>
parents:
2
diff
changeset
|
13 mozmill/README.txt https://developer.mozilla.org/en/Mozmill |
550f4b240e20
make almost look like what we want to do
Jeff Hammel <jhammel@mozilla.com>
parents:
2
diff
changeset
|
14 mozmill/docs/ https://developer.mozilla.org/en/Mozmill/ |
9 | 15 |
16 --dest sets the destination, e.g. | |
17 | |
18 --dest http://developer.mozilla.org/ | |
19 --dest https://developer-stage9.mozilla.org/jhammel | |
20 --dest path/to directory | |
21 | |
22 By default, a new temporary directory will be created | |
0 | 23 """ |
24 | |
5
3464eda1af80
better formatting for command line
Jeff Hammel <jhammel@mozilla.com>
parents:
4
diff
changeset
|
25 import optparse |
0 | 26 import os |
27 import sys | |
9 | 28 import tempfile |
0 | 29 import urllib2 |
30 | |
22
67e4becc7d49
first steps for cleaning up this awful mess
Jeff Hammel <jhammel@mozilla.com>
parents:
20
diff
changeset
|
31 # import markdown |
0 | 32 try: |
33 import markdown | |
34 except ImportError: | |
35 raise ImportError("markdown is not installed, run (e.g.):\neasy_install Markdown") | |
36 | |
22
67e4becc7d49
first steps for cleaning up this awful mess
Jeff Hammel <jhammel@mozilla.com>
parents:
20
diff
changeset
|
37 destinations = {'stage': 'https://developer-stage9.mozilla.org/@api/deki/pages/=%(page)s/contents', |
67e4becc7d49
first steps for cleaning up this awful mess
Jeff Hammel <jhammel@mozilla.com>
parents:
20
diff
changeset
|
38 'MDN': 'https://developer.mozilla.org/@api/deki/pages/=%(page)s/contents'} |
67e4becc7d49
first steps for cleaning up this awful mess
Jeff Hammel <jhammel@mozilla.com>
parents:
20
diff
changeset
|
39 |
0 | 40 |
41 def find_readme(directory): | |
42 """find a README file in a directory""" | |
4
550f4b240e20
make almost look like what we want to do
Jeff Hammel <jhammel@mozilla.com>
parents:
2
diff
changeset
|
43 # XXX currently unused |
5
3464eda1af80
better formatting for command line
Jeff Hammel <jhammel@mozilla.com>
parents:
4
diff
changeset
|
44 README=['README.md', 'README.txt', 'README'] |
0 | 45 for name in README: |
46 path = os.path.join(directory, name) | |
47 if os.path.exists(path): | |
48 return path | |
49 | |
18 | 50 def all_files(directory): |
22
67e4becc7d49
first steps for cleaning up this awful mess
Jeff Hammel <jhammel@mozilla.com>
parents:
20
diff
changeset
|
51 """get all files in a directory tree""" |
18 | 52 filenames = [] |
53 for dirpath, dirnames, files in os.walk(directory): | |
54 filenames.extend([os.path.join(dirpath, f) for f in files]) | |
55 return sorted(filenames) | |
56 | |
22
67e4becc7d49
first steps for cleaning up this awful mess
Jeff Hammel <jhammel@mozilla.com>
parents:
20
diff
changeset
|
57 def parse_manifest(filename, directory=None): |
4
550f4b240e20
make almost look like what we want to do
Jeff Hammel <jhammel@mozilla.com>
parents:
2
diff
changeset
|
58 """ |
550f4b240e20
make almost look like what we want to do
Jeff Hammel <jhammel@mozilla.com>
parents:
2
diff
changeset
|
59 reads a documentation manifest; returns a list of two-tuples: |
6 | 60 [(filename, destination)] |
4
550f4b240e20
make almost look like what we want to do
Jeff Hammel <jhammel@mozilla.com>
parents:
2
diff
changeset
|
61 """ |
550f4b240e20
make almost look like what we want to do
Jeff Hammel <jhammel@mozilla.com>
parents:
2
diff
changeset
|
62 |
6 | 63 assert os.path.exists(filename) and os.path.isfile(filename), "%s not found" % filename |
64 | |
4
550f4b240e20
make almost look like what we want to do
Jeff Hammel <jhammel@mozilla.com>
parents:
2
diff
changeset
|
65 if directory is None: |
550f4b240e20
make almost look like what we want to do
Jeff Hammel <jhammel@mozilla.com>
parents:
2
diff
changeset
|
66 directory = os.path.dirname(os.path.abspath(filename)) |
5
3464eda1af80
better formatting for command line
Jeff Hammel <jhammel@mozilla.com>
parents:
4
diff
changeset
|
67 lines = [line.strip() for line in file(filename).readlines()] |
4
550f4b240e20
make almost look like what we want to do
Jeff Hammel <jhammel@mozilla.com>
parents:
2
diff
changeset
|
68 lines = [line for line in lines |
550f4b240e20
make almost look like what we want to do
Jeff Hammel <jhammel@mozilla.com>
parents:
2
diff
changeset
|
69 if line and not line.startswith('#')] |
550f4b240e20
make almost look like what we want to do
Jeff Hammel <jhammel@mozilla.com>
parents:
2
diff
changeset
|
70 items = [] |
550f4b240e20
make almost look like what we want to do
Jeff Hammel <jhammel@mozilla.com>
parents:
2
diff
changeset
|
71 for line in lines: |
550f4b240e20
make almost look like what we want to do
Jeff Hammel <jhammel@mozilla.com>
parents:
2
diff
changeset
|
72 try: |
22
67e4becc7d49
first steps for cleaning up this awful mess
Jeff Hammel <jhammel@mozilla.com>
parents:
20
diff
changeset
|
73 f, page = line.split() |
4
550f4b240e20
make almost look like what we want to do
Jeff Hammel <jhammel@mozilla.com>
parents:
2
diff
changeset
|
74 # TODO: include options as third segment (e.g. format=ReST) |
550f4b240e20
make almost look like what we want to do
Jeff Hammel <jhammel@mozilla.com>
parents:
2
diff
changeset
|
75 except ValueError: |
550f4b240e20
make almost look like what we want to do
Jeff Hammel <jhammel@mozilla.com>
parents:
2
diff
changeset
|
76 raise ValueError("illegal manifest line: '%s'" % line) |
550f4b240e20
make almost look like what we want to do
Jeff Hammel <jhammel@mozilla.com>
parents:
2
diff
changeset
|
77 |
550f4b240e20
make almost look like what we want to do
Jeff Hammel <jhammel@mozilla.com>
parents:
2
diff
changeset
|
78 filename = os.path.join(directory, f) |
550f4b240e20
make almost look like what we want to do
Jeff Hammel <jhammel@mozilla.com>
parents:
2
diff
changeset
|
79 if os.path.isdir(filename): |
22
67e4becc7d49
first steps for cleaning up this awful mess
Jeff Hammel <jhammel@mozilla.com>
parents:
20
diff
changeset
|
80 raise NotImplementedError |
18 | 81 files = all_files(filename) |
82 for i in files: | |
83 relpath = os.path.relpath(i, filename) | |
22
67e4becc7d49
first steps for cleaning up this awful mess
Jeff Hammel <jhammel@mozilla.com>
parents:
20
diff
changeset
|
84 items.append((i, relpath)) |
4
550f4b240e20
make almost look like what we want to do
Jeff Hammel <jhammel@mozilla.com>
parents:
2
diff
changeset
|
85 else: |
22
67e4becc7d49
first steps for cleaning up this awful mess
Jeff Hammel <jhammel@mozilla.com>
parents:
20
diff
changeset
|
86 items.append((filename, page)) |
4
550f4b240e20
make almost look like what we want to do
Jeff Hammel <jhammel@mozilla.com>
parents:
2
diff
changeset
|
87 return items |
550f4b240e20
make almost look like what we want to do
Jeff Hammel <jhammel@mozilla.com>
parents:
2
diff
changeset
|
88 |
0 | 89 def main(args=sys.argv[1:]): |
90 | |
9 | 91 # default output directory |
92 default_dir = tempfile.mktemp() | |
93 | |
0 | 94 # parse command line options |
4
550f4b240e20
make almost look like what we want to do
Jeff Hammel <jhammel@mozilla.com>
parents:
2
diff
changeset
|
95 usage = '%prog [options] manifest <manifest> <...>' |
5
3464eda1af80
better formatting for command line
Jeff Hammel <jhammel@mozilla.com>
parents:
4
diff
changeset
|
96 |
3464eda1af80
better formatting for command line
Jeff Hammel <jhammel@mozilla.com>
parents:
4
diff
changeset
|
97 # description formatter |
3464eda1af80
better formatting for command line
Jeff Hammel <jhammel@mozilla.com>
parents:
4
diff
changeset
|
98 class PlainDescriptionFormatter(optparse.IndentedHelpFormatter): |
3464eda1af80
better formatting for command line
Jeff Hammel <jhammel@mozilla.com>
parents:
4
diff
changeset
|
99 def format_description(self, description): |
3464eda1af80
better formatting for command line
Jeff Hammel <jhammel@mozilla.com>
parents:
4
diff
changeset
|
100 if description: |
13
1efb669ab1c8
better description formatting
Jeff Hammel <jhammel@mozilla.com>
parents:
12
diff
changeset
|
101 return description.strip() + '\n' |
5
3464eda1af80
better formatting for command line
Jeff Hammel <jhammel@mozilla.com>
parents:
4
diff
changeset
|
102 else: |
3464eda1af80
better formatting for command line
Jeff Hammel <jhammel@mozilla.com>
parents:
4
diff
changeset
|
103 return '' |
3464eda1af80
better formatting for command line
Jeff Hammel <jhammel@mozilla.com>
parents:
4
diff
changeset
|
104 |
3464eda1af80
better formatting for command line
Jeff Hammel <jhammel@mozilla.com>
parents:
4
diff
changeset
|
105 parser = optparse.OptionParser(usage=usage, description=__doc__, formatter=PlainDescriptionFormatter()) |
0 | 106 parser.add_option('-d', '--directory', dest='directory', |
6 | 107 help='render the documentation from this directory') |
15
d9026d114655
deal with eccentricities of local directories
Jeff Hammel <jhammel@mozilla.com>
parents:
14
diff
changeset
|
108 parser.add_option('-o', '--dest', dest='dest', |
9 | 109 default=default_dir, |
110 help='base directory or URL of destination [DEFAULT: %default]') | |
4
550f4b240e20
make almost look like what we want to do
Jeff Hammel <jhammel@mozilla.com>
parents:
2
diff
changeset
|
111 parser.add_option('-u', '--user', dest='user', |
550f4b240e20
make almost look like what we want to do
Jeff Hammel <jhammel@mozilla.com>
parents:
2
diff
changeset
|
112 help='user name') |
20 | 113 parser.add_option('-p', '--password', dest='password', |
114 help='user password') | |
6 | 115 parser.add_option('--list', dest='list', action='store_true', default=False, |
116 help="list files") | |
9 | 117 parser.add_option('--validate', dest='validate', # TODO unused |
118 action='store_true', default=False, | |
119 help="validate the rendering but don't output") | |
4
550f4b240e20
make almost look like what we want to do
Jeff Hammel <jhammel@mozilla.com>
parents:
2
diff
changeset
|
120 options, manifests = parser.parse_args(args) |
0 | 121 |
6 | 122 # print help if no manifests given |
4
550f4b240e20
make almost look like what we want to do
Jeff Hammel <jhammel@mozilla.com>
parents:
2
diff
changeset
|
123 if not args: |
5
3464eda1af80
better formatting for command line
Jeff Hammel <jhammel@mozilla.com>
parents:
4
diff
changeset
|
124 parser.print_help() |
4
550f4b240e20
make almost look like what we want to do
Jeff Hammel <jhammel@mozilla.com>
parents:
2
diff
changeset
|
125 parser.exit() |
0 | 126 |
7 | 127 # get base url |
11 | 128 assert options.dest |
7 | 129 if '://' in options.dest: |
130 baseurl = options.dest | |
131 else: | |
15
d9026d114655
deal with eccentricities of local directories
Jeff Hammel <jhammel@mozilla.com>
parents:
14
diff
changeset
|
132 baseurl = 'file://' + os.path.abspath(options.dest) |
7 | 133 |
6 | 134 # read the manifests |
135 files = [] | |
136 for manifest in manifests: | |
22
67e4becc7d49
first steps for cleaning up this awful mess
Jeff Hammel <jhammel@mozilla.com>
parents:
20
diff
changeset
|
137 for item in parse_manifest(manifest, options.directory): |
6 | 138 if item not in files: |
139 files.append(item) | |
140 if options.list: | |
141 for item in files: | |
14 | 142 print '%s -> %s' % item |
17
0a1aecef2c52
youre done after listing files
Jeff Hammel <jhammel@mozilla.com>
parents:
16
diff
changeset
|
143 return |
0 | 144 |
9 | 145 if not files: |
146 return # you're done | |
147 | |
0 | 148 # render and upload READMEs |
11 | 149 if baseurl.startswith('file://'): |
150 options.dest = baseurl[len('file://'):] # deals with --dest file:///foo from command line | |
8 | 151 |
11 | 152 # ensure a directory |
153 if os.path.exists(options.dest): | |
154 assert os.path.isdir(options.dest), "'%s' - not a directory" % options.dest | |
8 | 155 |
156 # TODO render to directory | |
9 | 157 for src, dest in files: |
15
d9026d114655
deal with eccentricities of local directories
Jeff Hammel <jhammel@mozilla.com>
parents:
14
diff
changeset
|
158 |
d9026d114655
deal with eccentricities of local directories
Jeff Hammel <jhammel@mozilla.com>
parents:
14
diff
changeset
|
159 if dest.startswith('file://'): |
d9026d114655
deal with eccentricities of local directories
Jeff Hammel <jhammel@mozilla.com>
parents:
14
diff
changeset
|
160 dest = dest[len('file://'):] |
11 | 161 |
162 # create a directory if needed | |
163 dirname = os.path.dirname(dest) | |
16
d6528dd74592
only create the directory if we need to
Jeff Hammel <jhammel@mozilla.com>
parents:
15
diff
changeset
|
164 if os.path.exists(dirname): |
19
493683e17eae
now renders correctly to filesystem for preview
Jeff Hammel <jhammel@mozilla.com>
parents:
18
diff
changeset
|
165 if not os.path.isdir(dirname): |
493683e17eae
now renders correctly to filesystem for preview
Jeff Hammel <jhammel@mozilla.com>
parents:
18
diff
changeset
|
166 # deal with filesystem directories vs PATH_INFO |
493683e17eae
now renders correctly to filesystem for preview
Jeff Hammel <jhammel@mozilla.com>
parents:
18
diff
changeset
|
167 f = file(dirname) |
493683e17eae
now renders correctly to filesystem for preview
Jeff Hammel <jhammel@mozilla.com>
parents:
18
diff
changeset
|
168 buffer = f.read() |
493683e17eae
now renders correctly to filesystem for preview
Jeff Hammel <jhammel@mozilla.com>
parents:
18
diff
changeset
|
169 f.close() |
493683e17eae
now renders correctly to filesystem for preview
Jeff Hammel <jhammel@mozilla.com>
parents:
18
diff
changeset
|
170 os.remove(dirname) |
493683e17eae
now renders correctly to filesystem for preview
Jeff Hammel <jhammel@mozilla.com>
parents:
18
diff
changeset
|
171 os.makedirs(dirname) |
493683e17eae
now renders correctly to filesystem for preview
Jeff Hammel <jhammel@mozilla.com>
parents:
18
diff
changeset
|
172 f = file(os.path.join(dirname, 'index.html'), 'w') |
493683e17eae
now renders correctly to filesystem for preview
Jeff Hammel <jhammel@mozilla.com>
parents:
18
diff
changeset
|
173 f.write(buffer) |
493683e17eae
now renders correctly to filesystem for preview
Jeff Hammel <jhammel@mozilla.com>
parents:
18
diff
changeset
|
174 f.close() |
16
d6528dd74592
only create the directory if we need to
Jeff Hammel <jhammel@mozilla.com>
parents:
15
diff
changeset
|
175 else: |
d6528dd74592
only create the directory if we need to
Jeff Hammel <jhammel@mozilla.com>
parents:
15
diff
changeset
|
176 os.makedirs(dirname) |
11 | 177 |
178 # render | |
179 f = file(dest, 'w') | |
180 buffer = markdown.Markdown().convert(file(src).read()) | |
181 f.write(buffer) | |
182 f.close() | |
6 | 183 else: |
20 | 184 # check credentials |
185 assert options.user and options.password, "Please supply your --user and --password" | |
186 | |
187 # upload the files | |
188 # XXX just use curl for now | |
189 import subprocess | |
12 | 190 for src, dest in files: |
20 | 191 dest += '/contents?edittime=now' |
192 print src, dest | |
11 | 193 |
10 | 194 if options.dest == default_dir: |
11 | 195 print "Files rendered to\n%s" % default_dir |
9 | 196 |
0 | 197 if __name__ == '__main__': |
198 main() |