diff --git a/bin/_ttbp.py b/bin/_ttbp.py
index 18e4f04..03ab750 100644
--- a/bin/_ttbp.py
+++ b/bin/_ttbp.py
@@ -1,5 +1,32 @@
#!/usr/bin/python
+'''
+ttbp: tilde town blogging platform
+(also known as the feels engine)
+a console-based blogging program developed for tilde.town
+copyright (c) 2016 ~endorphant (endorphant@tilde.town)
+
+_ttbp.py:
+the beta version of the main console interface
+
+GNU GPL BOILERPLATE:
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see .
+
+the complete codebase is available at:
+https://github.com/modgethanc/ttbp
+'''
+
import os
import random
import tempfile
diff --git a/bin/chatter.py b/bin/chatter.py
index e95f621..fada0ab 100644
--- a/bin/chatter.py
+++ b/bin/chatter.py
@@ -1,5 +1,34 @@
#!/usr/bin/python
+'''
+ttbp: tilde town blogging platform
+(also known as the feels engine)
+a console-based blogging program developed for tilde.town
+copyright (c) 2016 ~endorphant (endorphant@tilde.town)
+
+chatter.py:
+some text processing utilities
+
+GNU GPL BOILERPLATE:
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see .
+
+the complete codebase is available at:
+https://github.com/modgethanc/ttbp
+'''
+
+import os
+
import random
import json
import os
diff --git a/bin/core.py b/bin/core.py
index 654b9ec..4a07ae1 100644
--- a/bin/core.py
+++ b/bin/core.py
@@ -1,5 +1,33 @@
#!/usr/bin/python
+'''
+ttbp: tilde town blogging platform
+(also known as the feels engine)
+a console-based blogging program developed for tilde.town
+copyright (c) 2016 ~endorphant (endorphant@tilde.town)
+
+core.py:
+this is a core handler for some ttbp standalone/output functions
+
+GNU GPL BOILERPLATE:
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see .
+
+the complete codebase is available at:
+https://github.com/modgethanc/ttbp
+'''
+
import os
import time
import subprocess
@@ -25,6 +53,10 @@ FOOTER = ""
FILES = []
def load():
+ '''
+ get all them globals set up!!
+ '''
+
global HEADER
global FOOTER
@@ -34,6 +66,13 @@ def load():
load_files()
def load_files():
+ '''
+ file loader
+
+ * reads user's nopub file
+ * loads all valid filenames that are not excluded in nopub to global files list
+ '''
+
global FILES
exclude = []
@@ -54,6 +93,14 @@ def load_files():
FILES.reverse()
def write(outurl="default.html"):
+ '''
+ main page renderer
+
+ * takes everything currently in FILES and writes a single non-paginated html
+ file
+ * calls write_page() on each file to make permalinks
+ '''
+
outfile = open(os.path.join(WWW, outurl), "w")
outfile.write("\n\n")
@@ -78,7 +125,12 @@ def write(outurl="default.html"):
return os.path.join(LIVE+USER,os.path.basename(os.path.realpath(WWW)),outurl)
def write_page(filename):
- # makes a single permalink page
+ '''
+ permalink generator
+
+ * makes a page out of a single entry for permalinking, using filename/date as
+ url
+ '''
outurl = os.path.join(WWW, "".join(parse_date(filename))+".html")
outfile = open(outurl, "w")
@@ -103,7 +155,12 @@ def write_page(filename):
return outurl
def write_entry(filename):
- # dump given file into entry format, return as list of strings
+ '''
+ entry text generator
+
+ * dump given file into entry format by parsing file as markdown
+ * return as list of strings
+ '''
date = parse_date(filename)
@@ -135,8 +192,15 @@ def write_entry(filename):
return entry
def parse_date(file):
- # assuming a filename of YYYYMMDD.txt, returns a list of
- # ['YYYY', 'MM', 'DD']
+ '''
+ parses date out of pre-validated filename
+
+ * assumes a filename of YYYYMMDD.txt
+ * returns a list:
+ [0] 'YYYY'
+ [1] 'MM'
+ [2] 'DD'
+ '''
rawdate = os.path.splitext(os.path.basename(file))[0]
@@ -145,14 +209,19 @@ def parse_date(file):
return date
def meta(entries = FILES):
- # takes a list of filenames and returns:
- # [0] absolute path
- # [1] ctime
- # [2] wc -w
- # [3] timestamp "DD month YYYY at HH:MM"
- # [4] entry date YYYY-MM-DD
- # [5] author
- # sorted in reverse date order by [4]
+ '''
+ metadata generator
+
+ * takes a list of filenames and returns a 2d list:
+ [0] absolute path
+ [1] ctime
+ [2] wc -w
+ [3] timestamp "DD month YYYY at HH:MM"
+ [4] entry date YYYY-MM-DD
+ [5] author
+
+ * sorted in reverse date order by [4]
+ '''
meta = []
@@ -172,7 +241,11 @@ def meta(entries = FILES):
return meta
def valid(filename):
- # check if the filename is YYYYMMDD.txt
+ '''
+ filename validator
+
+ * check if the filename is YYYYMMDD.txt
+ '''
filesplit = os.path.splitext(os.path.basename(filename))
@@ -187,8 +260,13 @@ def valid(filename):
return True
def write_global_feed(blogList):
- # takes an array of the current global blog status and prints it to
- # set www
+ '''
+ main ttbp index printer
+
+ * sources README.md for documentation
+ * takes incoming list of formatted blog links for all publishing blogs and
+ prints to blog feed
+ '''
outfile = open(FEED, "w")
@@ -207,7 +285,7 @@ def write_global_feed(blogList):
-
-
-""")
- outfile.close()
#############
#############
#############
diff --git a/bin/ttbp.py b/bin/ttbp.py
index ddd7a41..d3f4278 100644
--- a/bin/ttbp.py
+++ b/bin/ttbp.py
@@ -1,5 +1,33 @@
#!/usr/bin/python
+'''
+ttbp: tilde town blogging platform
+(also known as the feels engine)
+a console-based blogging program developed for tilde.town
+copyright (c) 2016 ~endorphant (endorphant@tilde.town)
+
+ttbp.py:
+the main console interface
+
+GNU GPL BOILERPLATE:
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see .
+
+the complete codebase is available at:
+https://github.com/modgethanc/ttbp
+'''
+
+import os
import os
import random
import tempfile
diff --git a/bin/util.py b/bin/util.py
index a8dc7a5..4993877 100644
--- a/bin/util.py
+++ b/bin/util.py
@@ -1,5 +1,24 @@
#!/usr/bin/python
+'''
+util.py: frequently used terminal and text processing utilities
+copyright (c) 2016 ~endorphant (endorphant@tilde.town)
+
+GNU GPL BOILERPLATE:
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see .
+'''
+
import inflect
import time
import random
diff --git a/lib/lang.json b/lib/lang.json
index aa7b709..b0cb469 100644
--- a/lib/lang.json
+++ b/lib/lang.json
@@ -7,12 +7,14 @@
"good afternoon",
"good day",
"good evening",
- "welcome back"
+ "welcome back",
+ "nice to see you"
],
"bye":[
"see you later, space cowboy",
"bye, townie",
- "until next time, friend"
+ "until next time, friend",
+ "come back whenever"
],
"friend":[
"friend",