Move all PEPs into subdirectory. Closes #10

This change moves all PEPs into the `peps/`
subdirectory. The HTML files generated by
`pep2html.py` will be located in `output/`.

The `make` to convert a single PEP to HTML
change slightly **if** you specify the path.
It's still the when specifying the id.

From: `make pep-0020.txt`
To: `make peps/pep-0020.txt`

... just use tab completion ;)

Author: timofurrer

.gitignore

@@ -1,8 +1,9 @@
-pep-0000.txt
-pep-????.html
-__pycache__
-*.pyc
-*.pyo
-*~
-*env
-.vscode
+pep-0000.txt
+pep-????.html
+__pycache__
+*.pyc
+*.pyo
+*~
+*env
+.vscode
+*.swp

Makefile

@@ -12,24 +12,23 @@ PYTHON=python
 .txt.html:
 	@$(PYTHON) $(PEP2HTML) $<
 
-TARGETS=$(patsubst %.txt,%.html,$(wildcard pep-????.txt)) pep-0000.html
+TARGETS=$(patsubst %.txt,%.html,$(wildcard peps/pep-????.txt)) output/pep-0000.html
 
 all: pep-0000.txt $(TARGETS)
 
 $(TARGETS): pep2html.py
 
-pep-0000.txt: $(wildcard pep-????.txt) $(wildcard pep0/*.py)
-	$(PYTHON) genpepindex.py .
+pep-0000.txt: $(wildcard peps/pep-????.txt) $(wildcard pep0/*.py)
+	$(PYTHON) genpepindex.py peps/
 
 rss:
-	$(PYTHON) pep2rss.py .
+	$(PYTHON) pep2rss.py peps/
 
 install:
 	echo "Installing is not necessary anymore. It will be done in post-commit."
 
 clean:
-	-rm pep-0000.txt
-	-rm *.html
+	-rm -r output/
 
 update:
 	git pull https://github.com/python/peps.git

README.rst

@@ -23,13 +23,16 @@
 
 from operator import attrgetter
 
-from pep0.output import write_pep0
-from pep0.pep import PEP, PEPError
+from peps.pep0.output import write_pep0
+from peps.pep0.pep import PEP, PEPError
+
+PEPDIR = "peps"
+OUTPUTDIR = "output"
 
 
 def main(argv):
     if not argv[1:]:
-        path = '.'
+        path = PEPDIR
     else:
         path = argv[1]
 
@@ -61,7 +64,12 @@ def main(argv):
     else:
         raise ValueError("argument must be a directory or file path")
 
-    with codecs.open('pep-0000.txt', 'w', encoding='UTF-8') as pep0_file:
+    try:
+        os.makedirs(OUTPUTDIR)
+    except OSError:  # output directory alrady exists. Everything's fine...
+        pass
+
+    with codecs.open(os.path.join(OUTPUTDIR, 'pep-0000.txt'), 'w', encoding='UTF-8') as pep0_file:
         write_pep0(peps, pep0_file)
 
 if __name__ == "__main__":

genpepindex.py

@@ -56,6 +56,8 @@
 PROGRAM = sys.argv[0]
 RFCURL = 'http://www.faqs.org/rfcs/rfc%d.html'
 PEPURL = 'pep-%04d.html'
+PEPDIR = 'peps'
+OUTPUTDIR = 'output'
 PEPCVSURL = ('https://hg.python.org/peps/file/tip/pep-%04d.txt')
 PEPDIRRUL = 'http://www.python.org/peps/'
 
@@ -371,7 +373,7 @@ def find_pep(pep_str):
     if os.path.exists(pep_str):
         return pep_str
     num = int(pep_str)
-    return "pep-%04d.txt" % num
+    return os.path.join(PEPDIR, "pep-%04d.txt" % num)
 
 def make_html(inpath, verbose=0):
     input_lines = get_input_lines(inpath)
@@ -390,7 +392,7 @@ def make_html(inpath, verbose=0):
     elif PEP_TYPE_DISPATCH[pep_type] == None:
         pep_type_error(inpath, pep_type)
         return None
-    outpath = os.path.splitext(inpath)[0] + ".html"
+    outpath = os.path.join(OUTPUTDIR, os.path.splitext(os.path.basename(inpath))[0] + ".html")
     if verbose:
         print(inpath, "(%s)" % pep_type, "->", outpath)
         sys.stdout.flush()
@@ -519,6 +521,11 @@ def main(argv=None):
         elif opt in ('-b', '--browse'):
             browse = 1
 
+    try:
+        os.makedirs(OUTPUTDIR)
+    except OSError:  # output directory alrady exists. Everything's fine...
+        pass
+
     if args:
         peptxt = []
         html = []
@@ -534,7 +541,7 @@ def main(argv=None):
         # do them all
         peptxt = []
         html = []
-        files = glob.glob("pep-*.txt")
+        files = glob.glob(os.path.join(PEPDIR, "pep-*.txt"))
         files.sort()
         for file in files:
             peptxt.append(file)

pep2html.py

@@ -46,6 +46,7 @@
 PEPCVSURL = 'http://hg.python.org/peps/file/tip/pep-%04d.txt'
 PEPDIRURL = '/dev/peps/'
 PEPURL = PEPDIRURL + 'pep-%04d'
+PEPDIR = 'peps'
 PEPANCHOR = '<a href="' + PEPURL + '">%i</a>'
 
 
@@ -499,7 +500,7 @@ def build_peps(args=None):
         filenames = pep_filename_generator(args)
     else:
         # do them all
-        filenames = glob.glob("pep-*.txt")
+        filenames = glob.glob(os.path.join(PEPDIR, "pep-*.txt"))
         filenames.sort()
     for filename in filenames:
         try:

pep2pyramid.py

@@ -16,7 +16,7 @@ def firstline_startingwith(full_path, text):
     return None
 
 # get list of peps with creation time (from "Created:" string in pep .txt)
-peps = glob.glob('pep-*.txt')
+peps = glob.glob('peps/pep-*.txt')
 def pep_creation_dt(full_path):
     created_str = firstline_startingwith(full_path, 'Created:')
     # bleh, I was hoping to avoid re but some PEPs editorialize