├── .github
└── CONTRIBUTING.md
├── .gitignore
├── LICENSE
├── README.html
├── README.md
├── changelog.txt
├── doc
├── manual.html
└── manual.md
├── screenshots
├── ttbp-compose.png
├── ttbp-entries.png
└── ttbp-main.png
├── setup.py
└── ttbp
├── __init__.py
├── chatter.py
├── config
├── __init__.py
├── banner-beta.txt
└── defaults
│ ├── footer.txt
│ ├── header.txt
│ └── style.css
├── core.py
├── gopher.py
├── ttbp.py
├── update.py
└── util.py
/.github/CONTRIBUTING.md:
--------------------------------------------------------------------------------
1 | # CONTRIBUTING GUIDELINES FOR TTBP
2 |
3 | Hi! Thanks for your interest in working on this project with me!
4 |
5 | Please understand that this may not be a beginner-friendly project to contribute
6 | to; this is because I am not a very experienced developer, and I'm still
7 | learning good practices for facilitating collaborative dev work. I'm open to
8 | receiving feedback and discussion even if you're new to writing Python,
9 | programming, or collaborative work in general, but I'd appreciate some extra
10 | patience and open communication.
11 |
12 | In general, please try to give me a heads up if you're intending to work on this
13 | codebase before either starting on it or submitting a PR. I'm fairly
14 | self-conscious about my code, so I want the best opportunity for respectful
15 | engagement, which lets me learn from my mistakes while still providing good
16 | software for end users.
17 |
18 | If you do not have the skills to contribute to the coding end, I still welcome
19 | your feedback about your experience using ttbp; please feel free to contact me
20 | with anything from vague appreciation to gripes about the interface! I'm
21 | interested in understanding how you feel about this program, and any information
22 | you give me will help me build a smoother tool for everyone! The ["feedback
23 | wanted"](https://github.com/modgethanc/ttbp/issues?q=is%3Aissue+is%3Aopen+label%3A"feedback+wanted")
24 | tag is a great place to start.
25 |
26 | ## Contacting Me
27 |
28 | You can send me tildemail at ~endorphant on tilde.town, or catch me in IRC
29 | (please send me a PM there, since I don't often monitor the main channel). I
30 | might not respond for a few days; this is normal! If you're feeling ignored,
31 | please feel free to open an issue in this repo, since that will ping my personal
32 | email directly, and we can catch up then.
33 |
34 | ## Bugs
35 |
36 | If you find a bug (such as: ttbp crashed while you were running it, an
37 | unexpected behavior happened, some parts of the interface don't line up
38 | correctly, etc.), please feel free to file an issue with this repo. You can also
39 | send me tildemail. Be as descriptive as possible! Describe the last few things
40 | that happened, if you remember them, and attach some representation of the bug
41 | (copy and paste the terminal output, or take a screenshot).
42 |
43 | If you can fix a bug that you found, please document the bug first by opening an
44 | issue, and check in with me before you start working on it. If there's a serious
45 | use-breaking bug in the current live code, and I'm unreachable for more than a
46 | few days, go ahead and fix it and send a PR, and I'll get to it when I can.
47 |
48 | ## Features
49 |
50 | Features that I intend to implement are often documented under ["upcoming
51 | features"](https://github.com/modgethanc/ttbp/issues?q=is%3Aissue+is%3Aopen+label%3A"upcoming+features")
52 | in the issue tracker. Feel free to weigh in on any features listed there!
53 |
54 | If there's a feature you'd like to see, but it isn't listed as upcoming, please
55 | check the list of issues and see if it's been discussed before (including in
56 | [closed
57 | issues](https://github.com/modgethanc/ttbp/issues?q=is%3Aissue+is%3Aclosed)).
58 | You're welcome to open a new issue if it seems like there isn't any history
59 | about your idea, and you can also send me tildemail to ask me about it.
60 |
61 | Please do not start coding new features without discussing your ideas with me
62 | first. I have some fairly strong ideas about how ttbp should work, and I don't
63 | want anyone to waste their time building new features that don't align with my
64 | vision for this project. That said, I'm definitely interested in hearing your
65 | ideas, and I'll do my best to communicate my philosophy regardless of if I
66 | greenlight your feature or not.
67 |
68 | ## Cosmetic Changes
69 |
70 | Please do not open PRs for cosmetic changes to the codebase if we haven't had a
71 | prior discussion about it. Cosmetic changes include things like whitespace,
72 | commenting/documentation, naming conventions, and other aspects of the codebase
73 | that would not affect end users if changed. I am cautiously open to receiving
74 | respectful feedback about my general coding style, but I'm not generally
75 | interested in unsolicited style critiques, or for coding conventions dictated to
76 | me. Thank you in advance for your understanding!
77 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | *.pyc
2 | *.swp
3 | *.egg-info
4 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Copyright (c) 2016 endorphant@tilde.town
2 |
3 | Permission is hereby granted, free of charge, to any person obtaining
4 | a copy of this software and associated documentation files (the
5 | "Software"), to deal in the Software without restriction, including
6 | without limitation the rights to use, copy, modify, merge, publish,
7 | distribute, sublicense, and/or sell copies of the Software, and to
8 | permit persons to whom the Software is furnished to do so, subject to
9 | the following conditions:
10 |
11 | The above copyright notice and this permission notice shall be
12 | included in all copies or substantial portions of the Software.
13 |
14 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 | EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16 | MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17 | NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18 | LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19 | OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20 | WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21 |
--------------------------------------------------------------------------------
/README.html:
--------------------------------------------------------------------------------
1 |
a command-line based blogging platform running on tilde.town
2 |
3 |
ttbp stands for “tilde.town blogging platform”, the original working name for
4 | this project.
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
ttbp runs from the command line, providing a hub for writing personal blog
13 | posts and reading posts written by other users of tilde.town. it’s a little bit
14 | like livejournal or dreamwidth or tumblr. you can opt to publish your posts to a
15 | public html file hosted on your tilde page, to tilde.town’s gopher server, or
16 | keep all your entries private to the tilde.town server.
17 |
18 |
to use, run feels while logged in to tilde.town
19 |
20 |
this is a project that runs on tilde.town, so all users of this program are
21 | expected to operate under the tilde.town code of
22 | conduct. content/personal issues should be
23 | worked out according to the CoC, with support from the administrative
24 | team if needed.
25 |
26 |
QUICK START
27 |
28 |
no coding or html experience is necessary to get started. just log in to your
29 | tilde.town account and enter:
30 |
31 |
feels
32 |
33 |
ttbp will ask you a few questions to get you started. after that, writing and
34 | reading entries all happen within the program.
35 |
36 |
that’s it!
37 |
38 |
support
39 |
40 |
if you’re having trouble getting started, or run into program errors or strange
41 | behavior, please send internal tilde.town mail to ~endorphant and i’ll try to
42 | sort things out!
43 |
44 |
there’s also a function from the main menu that lets you send feedback/inquiries
45 | to me directly; this uses internal tilde.town mail, which is what i’ll respond
46 | to.
47 |
48 |
writing entries
49 |
50 |
entries are recorded as plaintext files in your ~/.ttbp/entries directory.
51 | ttbp will use your selected editor to open and write files; each day is its
52 | own entry, like a diary page. at midnight for whatever timezone you’ve set for
53 | your user account on tilde.town, you’ll get a fresh entry. if you don’t write
54 | any feels on a particular day, no entries will show up there.
55 |
56 |
when you save and quit the text editor, your entry will automatically propagate
57 | to the global feels list; if you’ve opted to publish your feels to html/gopher,
58 | those files will update immediately. you can always go back to the current day’s
59 | entry and edit/add as you’d like, but older entries will not be available for
60 | editing from ttbp.
61 |
62 |
(since files are just stored as plaintext in your directory, it’s possible to
63 | edit and move old entries directly from the command line. however, changing old
64 | entries might cause strange things to happen with timestamps. the main program
65 | looks at the filename first for setting the date, then the last modified time to
66 | sort recent posts. it expects YYYMMDD.txt as the filename; anything else won’t
67 | show up as a valid entry. yes, this means you can post things out of date order
68 | by creating files with any date you want.)
you can also put things between <!-- comments --> to have them show up
76 | in the feed but not render in a browser (but people can still read
77 | them with view-source)
78 |
79 |
80 |
81 |
reading other feels
82 |
83 |
the browse global feels feature shows the ten most recent entries that anyone
84 | has written on ttbp. this list is only accessible from within tilde.town,
85 | although individual entries may be posted to html or gopher.
86 |
87 |
you can also pull up a list of a single user’s feels through check out your
88 | neighbors, which displays all users who are writing on ttbp based on their
89 | most recently updated entry, and a link to their public html blog if they’ve
90 | opted to publish their posts.
91 |
92 |
please note! entries written on ttbp should be considered sensitive,
93 | private information, even if a particular user is publishing entries in a
94 | world-viewable way! please be respectful about having access to other people’s
95 | feels, and do not copy/repeat any information without getting their explicit
96 | permission. tilde.town operates on a high level of mutual trust, and ttbp is
97 | designed to give individuals control over their content.
98 |
99 |
subscribing to users
100 |
101 |
the visit your subscriptions feature lets you view recent entries from a list
102 | of users you’ve subscribed to, as well as manage your subscription list. your
103 | list is saved to ~/.ttbp/config/subs, which gets automatically updated when
104 | you add or remove subscriptions from ttbp.
105 |
106 |
your subscription list is private; this means no one other than you can see who
107 | you’re following. subscription view only shows the 50 most recent entries from
108 | your subscribe list; if you want to see more entries from an individual, you
109 | can navigate to their entries in `check out your neighbors from the main
110 | menu.
111 |
112 |
privacy
113 |
114 |
when you start your ttbp, you have the option of publishing or not publishing
115 | your blog.
116 |
117 |
if you opt to not publish, your entires will never be accessible from outside of
118 | the tilde.town network; other tilde.town users will still be able to read your
119 | entries through the ttbp interface, or by directly accessing your
120 | ~/.ttbp/entries directory.
121 |
122 |
if you want to further protect your entries, you can chmod 700 your entries
123 | directory.
124 |
125 |
if you opt to publish, the program creates a directory ~/.ttbp/www where it
126 | stores all html files it generates, and symlinks this from your ~/public_html
127 | with your chosen blog directory. your blog will also be listed on the main ttbp
128 | page.
129 |
130 |
you can also opt to publish to gopher, and the program will automatically
131 | generate a gophermap of your feels.
132 |
133 |
you can set publishing status on individual entries, or bury individual feels;
134 | see “data management” below for details.
135 |
136 |
data management
137 |
138 |
the manage your feels menu provides several tools for organizing your feels.
139 | these are all actions you can perform manually from the command line, but doing
140 | them from within the program can help keep your files properly linked up.
141 |
142 |
143 |
read over feels–a list of all your entries, which you can open and
144 | read like any other feel
145 |
modify feels publishing–this lets you toggle privacy on individual
146 | posts. entries marked (nopub) will not get written to html or gopher,
147 | and toggling them from this menu will immediately publish or unpublish
148 | that entry (if you’re not publishing your posts at all, these settings
149 | won’t matter, since your feels will never show up outside of tilde.town)
150 |
backup your feels–makes a .tar.gz of all your entries, saving one
151 | copy to ~/.ttbp/backups/ with the current date, and a second copy to
152 | your home directory for safekeeping.
153 |
import a feels backup–unpacks a backup file into your current feels
154 | list. this tool checks the ~/.ttbp/backups directory for archives, and
155 | expects a file created by the above backup utility. if it detects any file
156 | collisions, it will preserve your current live copy and leave the backup
157 | verison in a temp directory, and notify you that this happened. also, any
158 | entries that were previously marked as (nopub) will retain their nopub
159 | status.
160 |
bury some feels–hides individual feels from viewing; entries are
161 | moved to ~/.ttbp/buried (and marked with a unique timestamp to prevent
162 | file collision) with permissions set to 600, meaning no one except you
163 | will be able to open that file. these entries are also hidden from your
164 | own view from read over feels, and you’ll have to open the files from
165 | the command line if you want to see them. this is intended to be a
166 | permament action, so you’ll be asked to type the entry date once to load
167 | the feel, then shown a preview of that feel, and then type the date again
168 | to confirm burying.
169 |
delete feels by day–permanently removes individual entries,
170 | including deleting published html/gopher files if needed. this action is
171 | not recoverable, unless you have a backup to restore; you’ll be asked to
172 | type the entry date once to load the feel, then shown a preview of that
173 | feel, and then type the date again to confirm deletion.
174 |
purge all feels–permanently removes all feels, including deleting
175 | all published html/gopher files if needed. this action is not recoverable,
176 | unless you have a backup to restore. you’ll be asked to type a
177 | one-time-use purge code to confirm this action.
178 |
wipe feels account–permanently removes all data associated with
179 | feels, including deleting any published hmtl/gopher files and removing
180 | your ~/.ttbp directory. any backups that you have in ~/.ttbp/backups
181 | will also be deleted with this action (which is why the backup function
182 | makes a second copy for safekeeping in your home directory). you will no
183 | longer show up in any lists as a user.
184 |
185 |
186 |
187 |
settings
188 |
189 |
the settings menu lets you change specific options for handling your feels and
190 | using the interface.
191 |
192 |
193 |
editor–set your text editor
194 |
gopher–opt in or out of automatically posting to gopher
195 |
post as nopub–set whether posts default to being published or not
196 | published (if you’re not publishing your feels, this doesn’t matter)
197 |
publish dir–set the directory under you public_html where feels will be
198 | published (if you’re not publishing your feels, this defaults to None)
199 |
publishing–opt in or out of automatically publishing entries to a
200 | world-readable html page
201 |
rainbows–opt in or out of having multicolored menu text
202 |
203 |
204 |
205 |
changing your page layout
206 |
207 |
you can modify how your blog looks by editing the stylesheet or header and
208 | footer files. the program sets you up with basic default. if you break your page
209 | somehow, you can force the program to regenerate your configuration by deleting
210 | your ~/.ttbp directory entirely. you might want to back up your
211 | ~/.ttbp/entries directory before you do this.
212 |
213 |
214 |
to modify your stylesheet, edit your ~/.ttbp/config/style.css
215 |
to modify the page header, edit your ~/.ttbp/config/header.txt
216 |
217 |
218 |
there’s a place marked off in the default header where you can safely put
219 | custom HTML elements!
220 |
221 |
222 |
to modify the page footer, edit your ~/.ttbp/config/footer.txt
223 |
224 |
225 |
226 |
general tips/troubleshooting
227 |
228 |
229 |
if the date looks like it’s ahead or behind, it’s because you haven’t set
230 | your local timezone yet. here are some
231 | timezone setting instructions
232 |
the feels burying tool will effectively clear your post for the day; you can
233 | use this feature to start a fresh entry on a particular day by burying the
234 | current day’s feels and then editing a new file
235 |
236 |
237 |
238 |
future features
239 |
240 |
these are a few ideas being kicked around, or under active development:
241 |
242 |
243 |
stylesheet/theme selector
244 |
better entry display within ttbp (currently just offloads to less)
please check out my contributor
267 | guidelines
268 | on github if you’d like to get involved with development!
269 |
270 |
if you find any bugs or strange behavior, please message me locally on tildemail
271 | or open a github issue and i’ll get back to you as soon as i can.
272 |
273 |
if you’re interested in helping with the code, please drop me some tildemail!
274 |
275 |
i accept tips for development work on
276 | liberapay
277 |
278 |
contributor shout-outs
279 |
280 |
thanks to:
281 |
282 |
283 |
~vilmibm, packaging help and gopher support
284 |
~sanqui, the bug swatter
285 |
~sinacutie, for css updates
286 |
287 |
288 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | *a command-line based blogging platform running on tilde.town*
2 |
3 | `ttbp` stands for "tilde.town blogging platform", the original working name for
4 | this project.
5 |
6 | 
7 |
8 | 
9 |
10 | 
11 |
12 | `ttbp` runs from the command line, providing a hub for writing personal blog
13 | posts and reading posts written by other users of tilde.town. it's a little bit
14 | like livejournal or dreamwidth or tumblr. you can opt to publish your posts to a
15 | public html file hosted on your tilde page, to tilde.town's gopher server, or
16 | keep all your entries private to the tilde.town server.
17 |
18 | to use, run `feels` while logged in to tilde.town
19 |
20 | this is a project that runs on tilde.town, so all users of this program are
21 | expected to operate under the tilde.town [code of
22 | conduct](http://tilde.town/wiki/conduct.html). content/personal issues should be
23 | worked out according to the CoC, with support from the [administrative
24 | team](http://tilde.town/wiki/administration/index.html) if needed.
25 |
26 |
27 | ### QUICK START
28 |
29 | no coding or html experience is necessary to get started. just log in to your
30 | tilde.town account and enter:
31 |
32 | `feels`
33 |
34 | ttbp will ask you a few questions to get you started. after that, writing and
35 | reading entries all happen within the program.
36 |
37 | that's it!
38 |
39 | ### support
40 |
41 | if you're having trouble getting started, or run into program errors or strange
42 | behavior, please send internal tilde.town mail to ~endorphant and i'll try to
43 | sort things out!
44 |
45 | there's also a function from the main menu that lets you send feedback/inquiries
46 | to me directly; this uses internal tilde.town mail, which is what i'll respond
47 | to.
48 |
49 | ### writing entries
50 |
51 | entries are recorded as plaintext files in your `~/.ttbp/entries` directory.
52 | `ttbp` will use your selected editor to open and write files; each day is its
53 | own entry, like a diary page. at midnight for whatever timezone you've set for
54 | your user account on tilde.town, you'll get a fresh entry. if you don't write
55 | any feels on a particular day, no entries will show up there.
56 |
57 | when you save and quit the text editor, your entry will automatically propagate
58 | to the global feels list; if you've opted to publish your feels to html/gopher,
59 | those files will update immediately. you can always go back to the current day's
60 | entry and edit/add as you'd like, but older entries will not be available for
61 | editing from `ttbp`.
62 |
63 | *(since files are just stored as plaintext in your directory, it's possible to
64 | edit and move old entries directly from the command line. however, changing old
65 | entries might cause strange things to happen with timestamps. the main program
66 | looks at the filename first for setting the date, then the last modified time to
67 | sort recent posts. it expects YYYMMDD.txt as the filename; anything else won't
68 | show up as a valid entry. yes, this means you can post things out of date order
69 | by creating files with any date you want.)*
70 |
71 | #### general entry-writing notes
72 |
73 | * you can use [markdown](https://daringfireball.net/projects/markdown/syntax)
74 | * you can use html
75 | * you can also put things between `` to have them show up
76 | in the feed but not render in a browser (but people can still read
77 | them with view-source)
78 |
79 | ### reading other feels
80 |
81 | the `browse global feels` feature shows the ten most recent entries that anyone
82 | has written on ttbp. this list is only accessible from within tilde.town,
83 | although individual entries may be posted to html or gopher.
84 |
85 | you can also pull up a list of a single user's feels through `check out your
86 | neighbors`, which displays all users who are writing on `ttbp` based on their
87 | most recently updated entry, and a link to their public html blog if they've
88 | opted to publish their posts.
89 |
90 | **please note!** entries written on `ttbp` should be considered sensitive,
91 | private information, even if a particular user is publishing entries in a
92 | world-viewable way! please be respectful about having access to other people's
93 | feels, and do not copy/repeat any information without getting their explicit
94 | permission. tilde.town operates on a high level of mutual trust, and `ttbp` is
95 | designed to give individuals control over their content.
96 |
97 | ### subscribing to users
98 |
99 | the `visit your subscriptions` feature lets you view recent entries from a list
100 | of users you've subscribed to, as well as manage your subscription list. your
101 | list is saved to `~/.ttbp/config/subs`, which gets automatically updated when
102 | you add or remove subscriptions from ttbp.
103 |
104 | your subscription list is private; this means no one other than you can see who
105 | you're following. subscription view only shows the 50 most recent entries from
106 | your subscribe list; if you want to see more entries from an individual, you
107 | can navigate to their entries in `check out your neighbors from the main
108 | menu.
109 |
110 | ### privacy
111 |
112 | when you start your ttbp, you have the option of publishing or not publishing
113 | your blog.
114 |
115 | if you opt to not publish, your entires will never be accessible from outside of
116 | the tilde.town network; other tilde.town users will still be able to read your
117 | entries through the ttbp interface, or by directly accessing your
118 | `~/.ttbp/entries` directory.
119 |
120 | if you want to further protect your entries, you can `chmod 700` your entries
121 | directory.
122 |
123 | if you opt to publish, the program creates a directory `~/.ttbp/www` where it
124 | stores all html files it generates, and symlinks this from your `~/public_html`
125 | with your chosen blog directory. your blog will also be listed on the [main ttbp
126 | page](https://tilde.town/~endorphant/ttbp).
127 |
128 | you can also opt to publish to gopher, and the program will automatically
129 | generate a gophermap of your feels.
130 |
131 | you can set publishing status on individual entries, or bury individual feels;
132 | see "data management" below for details.
133 |
134 | ### data management
135 |
136 | the `manage your feels` menu provides several tools for organizing your feels.
137 | these are all actions you can perform manually from the command line, but doing
138 | them from within the program can help keep your files properly linked up.
139 |
140 | * **read over feels**--a list of all your entries, which you can open and
141 | read like any other feel
142 | * **modify feels publishing**--this lets you toggle privacy on individual
143 | posts. entries marked `(nopub)` will not get written to html or gopher,
144 | and toggling them from this menu will immediately publish or unpublish
145 | that entry (if you're not publishing your posts at all, these settings
146 | won't matter, since your feels will never show up outside of tilde.town)
147 | * **backup your feels**--makes a .tar.gz of all your entries, saving one
148 | copy to `~/.ttbp/backups/` with the current date, and a second copy to
149 | your home directory for safekeeping.
150 | * **import a feels backup**--unpacks a backup file into your current feels
151 | list. this tool checks the `~/.ttbp/backups` directory for archives, and
152 | expects a file created by the above backup utility. if it detects any file
153 | collisions, it will preserve your current live copy and leave the backup
154 | verison in a temp directory, and notify you that this happened. also, any
155 | entries that were previously marked as `(nopub)` will retain their nopub
156 | status.
157 | * **bury some feels**--hides individual feels from viewing; entries are
158 | moved to `~/.ttbp/buried` (and marked with a unique timestamp to prevent
159 | file collision) with permissions set to 600, meaning no one except you
160 | will be able to open that file. these entries are also hidden from your
161 | own view from `read over feels`, and you'll have to open the files from
162 | the command line if you want to see them. this is intended to be a
163 | permament action, so you'll be asked to type the entry date once to load
164 | the feel, then shown a preview of that feel, and then type the date again
165 | to confirm burying.
166 | * **delete feels by day**--*permanently removes individual entries*,
167 | including deleting published html/gopher files if needed. this action is
168 | not recoverable, unless you have a backup to restore; you'll be asked to
169 | type the entry date once to load the feel, then shown a preview of that
170 | feel, and then type the date again to confirm deletion.
171 | * **purge all feels**--*permanently removes all feels*, including deleting
172 | all published html/gopher files if needed. this action is not recoverable,
173 | unless you have a backup to restore. you'll be asked to type a
174 | one-time-use purge code to confirm this action.
175 | * **wipe feels account**--*permanently removes all data associated with
176 | feels*, including deleting any published hmtl/gopher files and removing
177 | your `~/.ttbp` directory. any backups that you have in `~/.ttbp/backups`
178 | will also be deleted with this action (which is why the backup function
179 | makes a second copy for safekeeping in your home directory). you will no
180 | longer show up in any lists as a user.
181 |
182 | ### settings
183 |
184 | the settings menu lets you change specific options for handling your feels and
185 | using the interface.
186 |
187 | * **editor**--set your text editor
188 | * **gopher**--opt in or out of automatically posting to gopher
189 | * **post as nopub**--set whether posts default to being published or not
190 | published (if you're not publishing your feels, this doesn't matter)
191 | * **publish dir**--set the directory under you `public_html` where feels will be
192 | published (if you're not publishing your feels, this defaults to `None`)
193 | * **publishing**--opt in or out of automatically publishing entries to a
194 | world-readable html page
195 | * **rainbows**--opt in or out of having multicolored menu text
196 |
197 | ### changing your page layout
198 |
199 | you can modify how your blog looks by editing the stylesheet or header and
200 | footer files. the program sets you up with basic default. if you break your page
201 | somehow, you can force the program to regenerate your configuration by deleting
202 | your ~/.ttbp directory entirely. **you might want to back up your
203 | ~/.ttbp/entries directory before you do this.**
204 |
205 | * to modify your stylesheet, edit your ~/.ttbp/config/style.css
206 | * to modify the page header, edit your ~/.ttbp/config/header.txt
207 | * there's a place marked off in the default header where you can safely put
208 | custom HTML elements!
209 | * to modify the page footer, edit your ~/.ttbp/config/footer.txt
210 |
211 | ### general tips/troubleshooting
212 |
213 | * if the date looks like it's ahead or behind, it's because you haven't set
214 | your local timezone yet. here are some
215 | [timezone setting instructions](http://www.cyberciti.biz/faq/linux-unix-set-tz-environment-variable/)
216 | * the feels burying tool will effectively clear your post for the day; you can
217 | use this feature to start a fresh entry on a particular day by burying the
218 | current day's feels and then editing a new file
219 |
220 | ### future features
221 |
222 | these are a few ideas being kicked around, or under active development:
223 |
224 | * stylesheet/theme selector
225 | * better entry display within ttbp (currently just offloads to `less`)
226 | * buried feels browser
227 |
228 | other ideas are listed on github as
229 | [upcoming features](https://github.com/modgethanc/ttbp/issues?q=is%3Aissue+is%3Aopen+label%3A"upcoming+features") or [feature requests](https://github.com/modgethanc/ttbp/issues?q=is%3Aissue+is%3Aopen+label%3A"feature+request")!
230 |
231 | ### dependencies
232 |
233 | (this section is only relevant if you plan on forking the repo and running an
234 | instance of this yourself)
235 |
236 | * [mistune](https://pypi.python.org/pypi/mistune)
237 | * [inflect](https://pypi.python.org/pypi/inflect)
238 | * [six](https://pypi.python.org/pypi/six)
239 |
240 | ### contributing
241 |
242 | please check out my [contributor
243 | guidelines](https://github.com/modgethanc/ttbp/blob/master/.github/CONTRIBUTING.md)
244 | on github if you'd like to get involved with development!
245 |
246 | if you find any bugs or strange behavior, please message me locally on tildemail
247 | or open a github issue and i'll get back to you as soon as i can.
248 |
249 | if you're interested in helping with the code, please drop me some tildemail!
250 |
251 | i accept tips for development work on
252 | [liberapay](https://liberapay.com/modgethanc)
253 |
254 | ### contributor shout-outs
255 |
256 | thanks to:
257 |
258 | * ~vilmibm, packaging help and gopher support
259 | * ~sanqui, the bug swatter
260 | * ~sinacutie, for css updates
261 | * ~epicmorphism, for fixing pagination scrolling
262 |
--------------------------------------------------------------------------------
/changelog.txt:
--------------------------------------------------------------------------------
1 | TO-DO:
2 | (near future features)
3 |
4 | -cw feature
5 | -account deletion/export
6 |
7 | (possible/far future features)
8 |
9 | -stylesheet selector
10 | -and make a couple more custom stylesheets
11 | -replying to entries??
12 | -direct mail to author
13 | -make a nicer entry view wrapper
14 | -maybe with a box? and a nicer feed view?
15 | -#hashtags
16 | -command line flags
17 | -shortcut to most recent feels, writing entry, seeing own entry
18 | -motd
19 | -rss
20 | -multiple posts per day
21 |
22 | ------
23 |
24 | CHANGELOG:
25 | ver 0.11.0
26 | -added rainbow menus
27 | -added pub/nopub selector
28 | -fixed pagination for 2 page lists
29 | -fixing a bunch of things that broke in settings update
30 | -announcing centralfeels
31 | -general code cleanup pass
32 |
33 | ver 0.10.1
34 | -gopher support (with help from ~vilmibm)
35 | -fixed settings menu
36 |
37 | ver 0.9.3 (by ~vilmibm)
38 | -packaging
39 | -easier to contribute to
40 |
41 | ver 0.9.2
42 | -paginated scrolling
43 |
44 | ver 0.9.1
45 | -graffiti wall!!!
46 |
47 | ver 0.9.0
48 | -documentation browser
49 | -reading neighbor feels lists
50 | -overall code scrubbing and documentation
51 |
52 | ver 0.8.7
53 | -fixing publish/nopub option setting from patcher
54 |
55 | ver 0.8.6; mostly structural changes
56 | -a freaking patch utility?! yes, there's a patch utility now
57 | -settings now has an option to publish or not publish your blog to
58 | public_html
59 | -changing your publish directory actually moves files correctly
60 | -html files are now stored at .ttbp/www, and the public_html path just
61 | symlinks there
62 | -style.css now lives in .ttbp/config, and is symlinked from www
63 |
64 | ver 0.8.5
65 | -publish feels directory to ~endorphant/ttbp/index.html
66 | -(beta only) colorized menus
67 |
68 | ver 0.8.0
69 | -markdown parsing for entries
70 |
71 | ver 0.7.5
72 | -COLORFUL BANNER
73 | -backend stuff; feedback uses sendmail, some code cleanup
74 |
75 | ver 0.7
76 | -fixed program crashing? maybe?
77 | -added credits
78 | -added filename validator
79 |
80 | ver 0.6.5
81 | -renamed FEELS ENGINE
82 | -changed neighbor view to show last update time instead of feels count
83 |
84 | ver 0.6
85 | -improving exit handling
86 | -sort neighbor view by most recently updated
87 | -capture input from recording feels screen
88 |
89 | ver 0.5
90 | -added reading own entries
91 | -added reading 10 most recent global entries
92 |
93 | ver 0.4
94 | -added list of all users with a ttbp
95 |
96 | ver 0.3
97 | -user setup, change settings
98 |
99 | ver 0.2
100 | -feedback form, post entry
101 |
102 | ver 0.1
103 | -acknowledges user
104 |
--------------------------------------------------------------------------------
/doc/manual.html:
--------------------------------------------------------------------------------
1 |
FEELS MANUAL
2 |
ttbp stands for "tilde.town blogging platform", the original working name for
3 | this project. the complete codebase is available on
4 | github.
5 |
ttbp runs from the command line, providing a hub for writing personal blog
6 | posts and reading posts written by other users of tilde.town. it's a little bit
7 | like livejournal or dreamwidth or tumblr. you can opt to publish your posts to a
8 | public html file hosted on your tilde page, to tilde.town's gopher server, or
9 | keep all your entries private to the tilde.town server.
10 |
this is a project that runs on tilde.town, so all users of this program are
11 | expected to operate under the tilde.town code of
12 | conduct. content/personal issues should be
13 | worked out according to the CoC, with support from the administrative
14 | team if needed.
15 |
support
16 |
if you're having trouble getting started, or run into program errors or strange
17 | behavior, please send internal tilde.town mail to ~endorphant and i'll try to
18 | sort things out!
19 |
there's also a function from the main menu that lets you send feedback/inquiries
20 | to me directly; this uses internal tilde.town mail, which is what i'll respond
21 | to.
22 |
writing entries
23 |
entries are recorded as plaintext files in your ~/.ttbp/entries directory.
24 | ttbp will use your selected editor to open and write files; each day is its
25 | own entry, like a diary page. at midnight for whatever timezone you've set for
26 | your user account on tilde.town, you'll get a fresh entry. if you don't write
27 | any feels on a particular day, no entries will show up there.
28 |
when you save and quit the text editor, your entry will automatically propagate
29 | to the global feels list; if you've opted to publish your feels to html/gopher,
30 | those files will update immediately. you can always go back to the current day's
31 | entry and edit/add as you'd like, but older entries will not be available for
32 | editing from ttbp.
33 |
(since files are just stored as plaintext in your directory, it's possible to
34 | edit and move old entries directly from the command line. however, changing old
35 | entries might cause strange things to happen with timestamps. the main program
36 | looks at the filename first for setting the date, then the last modified time to
37 | sort recent posts. it expects YYYMMDD.txt as the filename; anything else won't
38 | show up as a valid entry. yes, this means you can post things out of date order
39 | by creating files with any date you want.)
you can also put things between <!-- comments --> to have them show up
45 | in the feed but not render in a browser (but people can still read them with
46 | view-source)
47 |
48 |
reading other feels
49 |
the browse global feels feature shows the ten most recent entries that anyone
50 | has written on ttbp. this list is only accessible from within tilde.town,
51 | although individual entries may be posted to html or gopher.
52 |
you can also pull up a list of a single user's feels through check out your
53 | neighbors, which displays all users who are writing on ttbp based on their
54 | most recently updated entry, and a link to their public html blog if they've
55 | opted to publish their posts.
56 |
please note! entries written on ttbp should be considered sensitive,
57 | private information, even if a particular user is publishing entries in a
58 | world-viewable way! please be respectful about having access to other people's
59 | feels, and do not copy/repeat any information without getting their explicit
60 | permission. tilde.town operates on a high level of mutual trust, and ttbp is
61 | designed to give individuals control over their content.
62 |
privacy
63 |
when you start your ttbp, you have the option of publishing or not publishing
64 | your blog.
65 |
if you opt to not publish, your entires will never be accessible from outside of
66 | the tilde.town network; other tilde.town users will still be able to read your
67 | entries through the ttbp interface, or by directly accessing your
68 | ~/.ttbp/entries directory.
69 |
if you want to further protect your entries, you can chmod 700 your entries
70 | directory.
71 |
if you opt to publish, the program creates a directory ~/.ttbp/www where it
72 | stores all html files it generates, and symlinks this from your ~/public_html
73 | with your chosen blog directory. your blog will also be listed on the main ttbp
74 | page.
75 |
you can also opt to publish to gopher, and the program will automatically
76 | generate a gophermap of your feels.
77 |
you can set publishing status on individual entries, or bury individual feels;
78 | see "data management" below for details.
79 |
data management
80 |
the manage your feels menu provides several tools for organizing your feels.
81 | these are all actions you can perform manually from the command line, but doing
82 | them from within the program can help keep your files properly linked up.
83 |
84 |
read over feels--a list of all your entries, which you can open and
85 | read like any other feel
86 |
modify feels publishing--this lets you toggle privacy on individual
87 | posts. entries marked (nopub) will not get written to html or gopher,
88 | and toggling them from this menu will immediately publish or unpublish
89 | that entry (if you're not publishing your posts at all, these settings
90 | won't matter, since your feels will never show up outside of tilde.town)
91 |
backup your feels--makes a .tar.gz of all your entries, saving one
92 | copy to ~/.ttbp/backups/ with the current date, and a second copy to
93 | your home directory for safekeeping.
94 |
import a feels backup--unpacks a backup file into your current feels
95 | list. this tool checks the ~/.ttbp/backups directory for archives, and
96 | expects a file created by the above backup utility. if it detects any file
97 | collisions, it will preserve your current live copy and leave the backup
98 | verison in a temp directory, and notify you that this happened. also, any
99 | entries that were previously marked as (nopub) will retain their nopub
100 | status.
101 |
bury some feels--hides individual feels from viewing; entries are
102 | moved to ~/.ttbp/buried (and marked with a unique timestamp to prevent
103 | file collision) with permissions set to 600, meaning no one except you
104 | will be able to open that file. these entries are also hidden from your
105 | own view from read over feels, and you'll have to open the files from
106 | the command line if you want to see them. this is intended to be a
107 | permament action, so you'll be asked to type the entry date once to load
108 | the feel, then shown a preview of that feel, and then type the date again
109 | to confirm burying.
110 |
delete feels by day--permanently removes individual entries,
111 | including deleting published html/gopher files if needed. this action is
112 | not recoverable, unless you have a backup to restore; you'll be asked to
113 | type the entry date once to load the feel, then shown a preview of that
114 | feel, and then type the date again to confirm deletion.
115 |
purge all feels--permanently removes all feels, including deleting
116 | all published html/gopher files if needed. this action is not recoverable,
117 | unless you have a backup to restore. you'll be asked to type a
118 | one-time-use purge code to confirm this action.
119 |
wipe feels account--permanently removes all data associated with
120 | feels, including deleting any published hmtl/gopher files and removing
121 | your ~/.ttbp directory. any backups that you have in ~/.ttbp/backups
122 | will also be deleted with this action (which is why the backup function
123 | makes a second copy for safekeeping in your home directory). you will no
124 | longer show up in any lists as a user.
125 |
126 |
settings
127 |
the settings menu lets you change specific options for handling your feels and
128 | using the interface.
129 |
130 |
editor--set your text editor
131 |
gopher--opt in or out of automatically posting to gopher
132 |
post as nopub--set whether posts default to being published or not
133 | published (if you're not publishing your feels, this doesn't matter)
134 |
publish dir--set the directory under you public_html where feels will be
135 | published (if you're not publishing your feels, this defaults to None)
136 |
publishing--opt in or out of automatically publishing entries to a
137 | world-readable html page
138 |
rainbows--opt in or out of having multicolored menu text
139 |
140 |
changing your page layout
141 |
you can modify how your blog looks by editing the stylesheet or header and
142 | footer files. the program sets you up with basic default. if you break your page
143 | somehow, you can force the program to regenerate your configuration by deleting
144 | your ~/.ttbp directory entirely. you might want to back up your
145 | ~/.ttbp/entries directory before you do this.
146 |
147 |
to modify your stylesheet, edit your ~/.ttbp/config/style.css
148 |
to modify the page header, edit your ~/.ttbp/config/header.txt
149 |
there's a place marked off in the default header where you can safely put
150 | custom HTML elements!
151 |
to modify the page footer, edit your ~/.ttbp/config/footer.txt
152 |
153 |
general tips/troubleshooting
154 |
155 |
if the date looks like it's ahead or behind, it's because you haven't set
156 | your local timezone yet. here are some
157 | timezone setting instructions
158 |
the feels burying tool will effectively clear your post for the day; you can
159 | use this feature to start a fresh entry on a particular day by burying the
160 | current day's feels and then editing a new file
161 |
162 |
future features
163 |
these are a few ideas being kicked around, or under active development:
164 |
165 |
stylesheet/theme selector
166 |
better entry display within ttbp (currently just offloads to less)
--------------------------------------------------------------------------------
/doc/manual.md:
--------------------------------------------------------------------------------
1 | # FEELS MANUAL #
2 |
3 | `ttbp` stands for "tilde.town blogging platform", the original working name for
4 | this project. the complete codebase is available on
5 | [github](https://github.com/modgethanc/ttbp).
6 |
7 | `ttbp` runs from the command line, providing a hub for writing personal blog
8 | posts and reading posts written by other users of tilde.town. it's a little bit
9 | like livejournal or dreamwidth or tumblr. you can opt to publish your posts to a
10 | public html file hosted on your tilde page, to tilde.town's gopher server, or
11 | keep all your entries private to the tilde.town server.
12 |
13 | this is a project that runs on tilde.town, so all users of this program are
14 | expected to operate under the tilde.town [code of
15 | conduct](http://tilde.town/wiki/conduct.html). content/personal issues should be
16 | worked out according to the CoC, with support from the [administrative
17 | team](http://tilde.town/wiki/administration/index.html) if needed.
18 |
19 | ### support
20 |
21 | if you're having trouble getting started, or run into program errors or strange
22 | behavior, please send internal tilde.town mail to ~endorphant and i'll try to
23 | sort things out!
24 |
25 | there's also a function from the main menu that lets you send feedback/inquiries
26 | to me directly; this uses internal tilde.town mail, which is what i'll respond
27 | to.
28 |
29 | ### writing entries
30 |
31 | entries are recorded as plaintext files in your `~/.ttbp/entries` directory.
32 | `ttbp` will use your selected editor to open and write files; each day is its
33 | own entry, like a diary page. at midnight for whatever timezone you've set for
34 | your user account on tilde.town, you'll get a fresh entry. if you don't write
35 | any feels on a particular day, no entries will show up there.
36 |
37 | when you save and quit the text editor, your entry will automatically propagate
38 | to the global feels list; if you've opted to publish your feels to html/gopher,
39 | those files will update immediately. you can always go back to the current day's
40 | entry and edit/add as you'd like, but older entries will not be available for
41 | editing from `ttbp`.
42 |
43 | *(since files are just stored as plaintext in your directory, it's possible to
44 | edit and move old entries directly from the command line. however, changing old
45 | entries might cause strange things to happen with timestamps. the main program
46 | looks at the filename first for setting the date, then the last modified time to
47 | sort recent posts. it expects YYYMMDD.txt as the filename; anything else won't
48 | show up as a valid entry. yes, this means you can post things out of date order
49 | by creating files with any date you want.)*
50 |
51 | #### general entry-writing notes
52 |
53 | * you can use [markdown](https://daringfireball.net/projects/markdown/syntax)
54 | * you can use html
55 | * you can also put things between `` to have them show up
56 | in the feed but not render in a browser (but people can still read them with
57 | view-source)
58 |
59 | ### reading other feels
60 |
61 | the `browse global feels` feature shows the ten most recent entries that anyone
62 | has written on ttbp. this list is only accessible from within tilde.town,
63 | although individual entries may be posted to html or gopher.
64 |
65 | you can also pull up a list of a single user's feels through `check out your
66 | neighbors`, which displays all users who are writing on `ttbp` based on their
67 | most recently updated entry, and a link to their public html blog if they've
68 | opted to publish their posts.
69 |
70 | **please note!** entries written on `ttbp` should be considered sensitive,
71 | private information, even if a particular user is publishing entries in a
72 | world-viewable way! please be respectful about having access to other people's
73 | feels, and do not copy/repeat any information without getting their explicit
74 | permission. tilde.town operates on a high level of mutual trust, and `ttbp` is
75 | designed to give individuals control over their content.
76 |
77 | ### privacy
78 |
79 | when you start your ttbp, you have the option of publishing or not publishing
80 | your blog.
81 |
82 | if you opt to not publish, your entires will never be accessible from outside of
83 | the tilde.town network; other tilde.town users will still be able to read your
84 | entries through the ttbp interface, or by directly accessing your
85 | `~/.ttbp/entries` directory.
86 |
87 | if you want to further protect your entries, you can `chmod 700` your entries
88 | directory.
89 |
90 | if you opt to publish, the program creates a directory `~/.ttbp/www` where it
91 | stores all html files it generates, and symlinks this from your `~/public_html`
92 | with your chosen blog directory. your blog will also be listed on the [main ttbp
93 | page](https://tilde.town/~endorphant/ttbp).
94 |
95 | you can also opt to publish to gopher, and the program will automatically
96 | generate a gophermap of your feels.
97 |
98 | you can set publishing status on individual entries, or bury individual feels;
99 | see "data management" below for details.
100 |
101 | ### data management
102 |
103 | the `manage your feels` menu provides several tools for organizing your feels.
104 | these are all actions you can perform manually from the command line, but doing
105 | them from within the program can help keep your files properly linked up.
106 |
107 | * **read over feels**--a list of all your entries, which you can open and
108 | read like any other feel
109 | * **modify feels publishing**--this lets you toggle privacy on individual
110 | posts. entries marked `(nopub)` will not get written to html or gopher,
111 | and toggling them from this menu will immediately publish or unpublish
112 | that entry (if you're not publishing your posts at all, these settings
113 | won't matter, since your feels will never show up outside of tilde.town)
114 | * **backup your feels**--makes a .tar.gz of all your entries, saving one
115 | copy to `~/.ttbp/backups/` with the current date, and a second copy to
116 | your home directory for safekeeping.
117 | * **import a feels backup**--unpacks a backup file into your current feels
118 | list. this tool checks the `~/.ttbp/backups` directory for archives, and
119 | expects a file created by the above backup utility. if it detects any file
120 | collisions, it will preserve your current live copy and leave the backup
121 | verison in a temp directory, and notify you that this happened. also, any
122 | entries that were previously marked as `(nopub)` will retain their nopub
123 | status.
124 | * **bury some feels**--hides individual feels from viewing; entries are
125 | moved to `~/.ttbp/buried` (and marked with a unique timestamp to prevent
126 | file collision) with permissions set to 600, meaning no one except you
127 | will be able to open that file. these entries are also hidden from your
128 | own view from `read over feels`, and you'll have to open the files from
129 | the command line if you want to see them. this is intended to be a
130 | permament action, so you'll be asked to type the entry date once to load
131 | the feel, then shown a preview of that feel, and then type the date again
132 | to confirm burying.
133 | * **delete feels by day**--*permanently removes individual entries*,
134 | including deleting published html/gopher files if needed. this action is
135 | not recoverable, unless you have a backup to restore; you'll be asked to
136 | type the entry date once to load the feel, then shown a preview of that
137 | feel, and then type the date again to confirm deletion.
138 | * **purge all feels**--*permanently removes all feels*, including deleting
139 | all published html/gopher files if needed. this action is not recoverable,
140 | unless you have a backup to restore. you'll be asked to type a
141 | one-time-use purge code to confirm this action.
142 | * **wipe feels account**--*permanently removes all data associated with
143 | feels*, including deleting any published hmtl/gopher files and removing
144 | your `~/.ttbp` directory. any backups that you have in `~/.ttbp/backups`
145 | will also be deleted with this action (which is why the backup function
146 | makes a second copy for safekeeping in your home directory). you will no
147 | longer show up in any lists as a user.
148 |
149 | ### settings
150 |
151 | the settings menu lets you change specific options for handling your feels and
152 | using the interface.
153 |
154 | * **editor**--set your text editor
155 | * **gopher**--opt in or out of automatically posting to gopher
156 | * **post as nopub**--set whether posts default to being published or not
157 | published (if you're not publishing your feels, this doesn't matter)
158 | * **publish dir**--set the directory under you `public_html` where feels will be
159 | published (if you're not publishing your feels, this defaults to `None`)
160 | * **publishing**--opt in or out of automatically publishing entries to a
161 | world-readable html page
162 | * **rainbows**--opt in or out of having multicolored menu text
163 |
164 | ### changing your page layout
165 |
166 | you can modify how your blog looks by editing the stylesheet or header and
167 | footer files. the program sets you up with basic default. if you break your page
168 | somehow, you can force the program to regenerate your configuration by deleting
169 | your ~/.ttbp directory entirely. **you might want to back up your
170 | ~/.ttbp/entries directory before you do this.**
171 |
172 | * to modify your stylesheet, edit your ~/.ttbp/config/style.css
173 | * to modify the page header, edit your ~/.ttbp/config/header.txt
174 | * there's a place marked off in the default header where you can safely put
175 | custom HTML elements!
176 | * to modify the page footer, edit your ~/.ttbp/config/footer.txt
177 |
178 | ### general tips/troubleshooting
179 |
180 | * if the date looks like it's ahead or behind, it's because you haven't set
181 | your local timezone yet. here are some
182 | [timezone setting instructions](http://www.cyberciti.biz/faq/linux-unix-set-tz-environment-variable/)
183 | * the feels burying tool will effectively clear your post for the day; you can
184 | use this feature to start a fresh entry on a particular day by burying the
185 | current day's feels and then editing a new file
186 |
187 | ### future features
188 |
189 | these are a few ideas being kicked around, or under active development:
190 |
191 | * stylesheet/theme selector
192 | * better entry display within ttbp (currently just offloads to `less`)
193 | * buried feels browser
194 |
195 | other ideas are listed on github as
196 | [upcoming features](https://github.com/modgethanc/ttbp/issues?q=is%3Aissue+is%3Aopen+label%3A"upcoming+features") or [feature requests](https://github.com/modgethanc/ttbp/issues?q=is%3Aissue+is%3Aopen+label%3A"feature+request")!
197 |
--------------------------------------------------------------------------------
/screenshots/ttbp-compose.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/modgethanc/ttbp/0aaedaff5a2738c11cfdaa29329533b9f4efaf28/screenshots/ttbp-compose.png
--------------------------------------------------------------------------------
/screenshots/ttbp-entries.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/modgethanc/ttbp/0aaedaff5a2738c11cfdaa29329533b9f4efaf28/screenshots/ttbp-entries.png
--------------------------------------------------------------------------------
/screenshots/ttbp-main.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/modgethanc/ttbp/0aaedaff5a2738c11cfdaa29329533b9f4efaf28/screenshots/ttbp-main.png
--------------------------------------------------------------------------------
/setup.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python
2 |
3 | from setuptools import setup
4 |
5 | setup(
6 | name='ttbp',
7 | version='0.12.2',
8 | description='command line social blogging tool used on tilde.town',
9 | url='https://github.com/modgethanc/ttbp',
10 | author='~endorphant',
11 | author_email='endorphant@tilde.town',
12 | license='MIT',
13 | classifiers=[
14 | 'Topic :: Artistic Software',
15 | 'License :: OSI Approved :: MIT License',
16 | ],
17 | keywords='blog',
18 | packages=['ttbp'],
19 | install_requires = [
20 | 'inflect==0.2.5',
21 | 'mistune==0.8.1',
22 | 'colorama==0.3.9',
23 | 'six'
24 | ],
25 | include_package_data = True,
26 | entry_points = {
27 | 'console_scripts': [
28 | 'feels = ttbp.ttbp:main',
29 | 'ttbp = ttbp.ttbp:main',
30 | ]
31 | },
32 | )
33 |
--------------------------------------------------------------------------------
/ttbp/__init__.py:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/modgethanc/ttbp/0aaedaff5a2738c11cfdaa29329533b9f4efaf28/ttbp/__init__.py
--------------------------------------------------------------------------------
/ttbp/chatter.py:
--------------------------------------------------------------------------------
1 | import json
2 | import os
3 | import random
4 |
5 | DEFAULT_LANG = {
6 | "greet":[
7 | "hi",
8 | "hey",
9 | "howdy",
10 | "good morning",
11 | "good afternoon",
12 | "good day",
13 | "good evening",
14 | "welcome back",
15 | "nice to see you"
16 | ],
17 | "bye":[
18 | "see you later, space cowboy",
19 | "bye, townie",
20 | "until next time, friend",
21 | "come back whenever"
22 | ],
23 | "friend":[
24 | "friend",
25 | "pal",
26 | "buddy",
27 | "townie"
28 | ],
29 | "months":{
30 | "01":"january",
31 | "02":"february",
32 | "03":"march",
33 | "04":"april",
34 | "05":"may",
35 | "06":"june",
36 | "07":"july",
37 | "08":"august",
38 | "09":"september",
39 | "10":"october",
40 | "11":"november",
41 | "12":"december"
42 | }
43 | }
44 |
45 | if os.path.exists("/home/endorphant/lib/python/chatterlib.json"):
46 | with open("/home/endorphant/lib/python/chatterlib.json", 'r') as f:
47 | LANG = json.load(f)
48 | else:
49 | LANG = DEFAULT_LANG
50 |
51 | def say(keyword):
52 | '''
53 | takes a keyword and randomly returns from language dictionary to match that keyword
54 |
55 | returns None if keyword doesn't exist
56 |
57 | TODO: validate keyword?
58 | '''
59 |
60 | return random.choice(LANG.get(keyword))
61 |
62 | def month(num):
63 | '''
64 | takes a MM and returns lovercase full name of that month
65 |
66 | TODO: validate num?
67 | '''
68 |
69 | return LANG["months"].get(num)
70 |
--------------------------------------------------------------------------------
/ttbp/config/__init__.py:
--------------------------------------------------------------------------------
1 | from __future__ import absolute_import
2 | import os
3 | import sys
4 | import time
5 |
6 | from .. import util
7 |
8 | ## System config
9 |
10 | # We refer to some package files (ie .css stuff), so we save a reference to the
11 | # path.
12 | INSTALL_PATH = os.path.dirname(sys.modules['ttbp'].__file__)
13 |
14 | # We use this to store any persisted, global state.
15 | VAR = '/var/global/ttbp'
16 | VAR_WWW = os.path.join(VAR, 'www')
17 |
18 | if not os.path.isdir('/var/global'):
19 | raise Exception('bad system state: /var/global does not exist.')
20 |
21 | if not os.path.isdir(VAR):
22 | os.mkdir(VAR)
23 |
24 | if not os.path.isdir(VAR_WWW):
25 | os.mkdir(VAR_WWW)
26 |
27 | LIVE = 'https://tilde.town/~'
28 | FEEDBOX = "endorphant@tilde.town"
29 | USERFILE = os.path.join(VAR, "users.txt")
30 | GRAFF_DIR = os.path.join(VAR, "graffiti")
31 | WALL = os.path.join(GRAFF_DIR, "wall.txt")
32 | WALL_LOCK = os.path.join(GRAFF_DIR, ".lock")
33 |
34 | if not os.path.isdir(GRAFF_DIR):
35 | os.mkdir(GRAFF_DIR)
36 |
37 | ## Defaults
38 |
39 | DEFAULT_HEADER = '''
40 |
41 |
42 |
43 | $USER on TTBP
44 |
45 |
46 |
47 |
56 |
57 |
58 | '''.lstrip()
59 |
60 | with open(os.path.join(INSTALL_PATH, 'config', 'defaults', 'style.css')) as f:
61 | DEFAULT_STYLE = f.read()
62 |
63 |
64 | ## User config
65 |
66 | USER = os.path.basename(os.path.expanduser('~'))
67 | USER_HOME = os.path.expanduser('~')
68 | PATH = os.path.join(USER_HOME, '.ttbp')
69 | PUBLIC = os.path.join(USER_HOME, 'public_html')
70 | WWW = os.path.join(PATH, 'www')
71 | GOPHER_ENTRIES = os.path.join(PATH, 'gopher')
72 | GOPHER_PATH = os.path.join(USER_HOME, 'public_gopher', 'feels')
73 | USER_CONFIG = os.path.join(PATH, 'config')
74 | TTBPRC = os.path.join(USER_CONFIG, 'ttbprc')
75 | MAIN_FEELS = os.path.join(PATH, 'entries')
76 | BURIED_FEELS = os.path.join(PATH, 'buried')
77 | NOPUB = os.path.join(USER_CONFIG, 'nopub')
78 | BACKUPS = os.path.join(PATH, 'backups')
79 | SUBS = os.path.join(USER_CONFIG, 'subs')
80 |
81 | ## UI
82 |
83 | BANNER = '''
84 | ___________________________________________________________
85 | | |
86 | | the tilde.town |
87 | | ____ ____ ____ _ ____ ____ _ _ ____ _ _ _ ____ |
88 | | |___ |___ |___ | [__ |___ |\ | | __ | |\ | |___ |
89 | | | |___ |___ |___ ___] |___ | \| |__] | | \| |___ |
90 | | ver 0.12.2 |
91 | |__________________________________________________________|
92 | '''.lstrip()
93 | # ~ u n s t a b l e e x p e r i m e n t a l b r a n c h ~
94 | #'''.lstrip()
95 |
96 | ## page texts
97 |
98 | intro_prompt = """
99 | i don't recognize you, stranger. let's make friends.
100 |
101 | the feels engine is an internal blogging platform on tilde.town. it assists you
102 | in recording your feels, giving you the option to publish to html or gopher, and
103 | read the feels of other users on tilde.town.
104 |
105 | press to set up an account, or to quit.
106 | """.lstrip()
107 |
108 | credits = """
109 | ttbp was written for tilde.town by ~endorphant in python. the codebase is
110 | publicly available on github at https://github.com/modgethanc/ttbp
111 |
112 | tips for development are accepted at https://liberapay.com/modgethanc/
113 |
114 | other contributors:
115 | ~vilmibm, packaging help and gopher support
116 | ~sanqui, the bug swatter
117 | ~sinacutie, for css updates
118 |
119 | if you have ideas for ttbp, you are welcome to contact me to discuss them;
120 | please send me tildemail or open a github issue. i am not a very experienced
121 | developer, and ttbp is one of my first public-facing projects, so i appreciate
122 | your patience while i learn how to be a better developer!
123 |
124 | i'd love to hear about your ideas and brainstorm about new features!
125 |
126 | thanks to everyone who reads, listens, writes, and feels."""
127 |
128 | recording = """
129 | feels will be recorded for today, {today}.
130 |
131 | if you've already started recording feels for this day, you
132 | can pick up where you left off.
133 |
134 | you can write your feels in plaintext, markdown, html, or a mixture of
135 | these.
136 |
137 | press to begin recording your feels in your chosen text
138 | editor.
139 |
140 | """.format(today=time.strftime("%d %B %Y"))
141 |
142 | bury_feels_prompt = """\
143 | burying a feel removes it from view, including your own. buried feels are
144 | stashed in a private directory at:
145 |
146 | {buried_dir}
147 |
148 | you can visit your feels there from the command line, but no one else can view
149 | those files.
150 |
151 | (a buried feels browser is in the works; for now, you'll have to use the
152 | command line to view your buried feels)
153 |
154 | which day's feels do you want to bury?
155 |
156 | YYYYMMDD (or 'q' to cancel)> """.format(buried_dir=BURIED_FEELS)
157 |
158 | account_wipe_prompt = """\
159 | warning! ! ! this action is irreversible!!!
160 |
161 | this tool will remove your entire presence from the feels engine. this includes
162 | all posts, settings, and published html/gopher feels. you will no longer be
163 | listed anywhere as a user here.
164 |
165 | there is no way for me to help you recover any part of your feels acccount. i
166 | respect your need to do this from time to time, so please be sure you're ready!
167 |
168 | i recommend that you make a backup of your feels and stash them somewhere safe,
169 | just in case a future version of you still wants to look them over."""
170 |
171 | feels_purge_prompt = """\
172 | warning! ! ! this action is irreversible!!!
173 |
174 | there is no way for me to help you recover your feels if you purge them all. i
175 | respect your need to do this from time to time, so please be sure you're ready!
176 |
177 | i recommend that you make a backup of your feels and stash them somewhere safe,
178 | just in case a future version of you still wants to look them over.
179 | """
180 |
181 | mystery_error = """\
182 | sorry, something went wrong! please try to address the error and try again.
183 | if you need help, ask in IRC or send mail to ~endorphant and we'll try to
184 | figure it out!
185 | """.lstrip()
186 |
187 | ## update announcements
188 |
189 | UPDATES = {
190 | "0.9.0": """
191 | ver. 0.9.0 features:
192 | * browsing other people's feels from neighbor view
193 | * documentation browser""",
194 | "0.9.1": """
195 | ver 0.9.1 features:
196 | * graffiti wall """,
197 | "0.9.2": """
198 | ver 0.9.2 features:
199 | * paginated entry view
200 | * improved entry listing performance so it should
201 | be less sluggish (for now)
202 | * expanded menu for viewing your own feels (further features to be implemented) """,
203 | "0.9.3": """
204 | version 0.9.3 features:
205 | * ttbp is now packaged, making it easier to contribute to.
206 | * things should otherwise be the same!
207 | * check out https://github.com/modgethanc/ttbp if you'd like to contribute.
208 | * takes advantage of new /var/global """,
209 | "0.10.1": """
210 | ~[version 0.10.1 features]~
211 | * thanks to help from ~vilmibm, ttbp now supports publishing to gopher!
212 | * if you enable gopher publishing, feels will automatically publish to
213 | gopher://tilde.town/1/~{user}/feels
214 | * if you don't know what gopher is, it's fine to opt-out; ask around on
215 | irc if you'd like to learn more!
216 | * the settings menu has been reworked to be less clunky""",
217 | "0.11.0": """
218 | ~[version 0.11.0 update]~
219 |
220 | * rainbow menus are now an option! please message ~endorphant (with
221 | screencaps, if possible) if rainbow menus are unreadable with your
222 | terminal settings, so adjustments can be made for future updates
223 | * you can now set individual posts to be published or not published; this
224 | option is listed under 'review your feels' as 'modify feels publishing',
225 | and is only available if you have publishing turned on. if you toggle
226 | your publishing state, this list will persist. unpublished posts will
227 | be removed from html/gopher, but will still be accessible from within
228 | the feels engine.
229 | * some errors in selecting and validating settings and creating publishing
230 | directories have been corrected
231 | * please send mail to ~endorphant or ask for help on IRC if you're still
232 | having issues with getting your settings sorted out!
233 |
234 | general PSA:
235 | * join #ttbp on the local irc network for help and discussion about the
236 | feels engine!
237 | * ~login created centralfeels, which is an opt-in collection of
238 | html-published feels; create a blank file called '.centralfeels' in
239 | your home directory if you'd like to be included!""",
240 | "0.11.1": """
241 | ~[version 0.11.1 update]~
242 |
243 | * a quick patch to correct a directory listing error, nothing too
244 | exciting
245 | * general PSA: feel free to use the github repo for bugs/feature requests:
246 | https://github.com/modgethanc/ttbp/issues""",
247 | "0.11.2": """
248 | ~[version 0.11.2 update]~
249 |
250 | * added a new option to allow setting entries to default to either public or
251 | non-public on posting; this option only really makes sense if you're
252 | already publishing to html/gopher, but is available either way!
253 |
254 | you can find this option under 'settings' as 'post as nopub'.""",
255 | "0.11.3": """
256 | ~[version 0.11.3 update]~
257 |
258 | * thanks to ~sinacutie, you can now set custom css for the permalink text
259 | styling on your html page. the default permalink style has been added to
260 | your current css file, and shouldn't change the appearance of your page.
261 |
262 | if you're not using custom css, don't worry about this!""",
263 | "0.12.0": """
264 | ~[version 0.12.0 update]~
265 |
266 | a lot of new stuff this time! from the main menu, option (1) is now called
267 | "manage your feels", which contains an expanded set of tools for organizing
268 | your feels:
269 | * read over feels (a list of all your entries)
270 | * modify feels publishing (toggle privacy on individual entries)
271 | * backup your feels (makes a .tar.gz of all your entries)
272 | * import a feels backup (unpacks a backup into your feels)
273 | * bury some feels (hide individual entries from view)
274 | * delete feels by day (permanently remove individual entries)
275 | * purge all feels (permanently remove all entries)
276 | * wipe feels account (permanently remove everything associated with
277 | ttbp)
278 |
279 | each of these tools has expanded descriptions and instructions from the
280 | menu, so check them out if you're curious! all of the irreversibl data
281 | management actions have confirmation actions, so it's easy to cancel if you
282 | accidentally access a tool.
283 |
284 | also, i've updated the documentation file to reflect recent feature changes,
285 | including some more details about how things work under the hood, and some
286 | clarifications on how existing features work. please give it a read through
287 | if you have a chance, and let me know if there's anything else i can
288 | improve!
289 |
290 | lastly, i just wanted to mention that i do accept tips for my dev work at
291 | https://liberapay.com/modgethanc/ but there's no pressure to donate at all,
292 | i'm just making this option available for anyone whose financially stable
293 | and wants to kick some spare change my way; this is a labor of love, and i'm
294 | happy to work on it regardless :)
295 | """,
296 | "0.12.1":"""
297 | ~[version 0.12.1 update]~
298 |
299 | new feature: "visit your subscriptions"
300 | * view recent entries from a list of townies you've subscribed to
301 | * subscription list is private; no one else can see who you're following
302 | * add/remove users from the subscription menu
303 |
304 | minor changes:
305 | * global feed now shows 50 most recent entries, which you can scroll through
306 | * documentation page updated to reflect new feature
307 | * graffiti wall lock releases after 3 days
308 |
309 | thanks for those of your who've written me with feedback!
310 |
311 | keep feelin' together <3
312 | """,
313 | "0.12.2":"""
314 | ~[version 0.12.2 update]~
315 |
316 | bug fix: ~epicmorphism helped out with fixing the pagination bug! now, when
317 | you scroll through a list of entries, it'll correctly return you to the
318 | page you were on if you open and close an item. thanks so much, friend <3
319 |
320 | thanks to everyone writing me with feedback; i've been real busy lately,
321 | and i might not get to making improvements or responding to mail for a
322 | while :(
323 |
324 | feel on!
325 | ~endo
326 | """
327 | }
328 |
--------------------------------------------------------------------------------
/ttbp/config/banner-beta.txt:
--------------------------------------------------------------------------------
1 | __________________________________________________________
2 | | |
3 | | the tilde.town |
4 | | ____ ____ ____ _ ____ ____ _ _ ____ _ _ _ ____ |
5 | | |___ |___ |___ | [__ |___ |\ | | __ | |\ | |___ |
6 | | | |___ |___ |___ ___] |___ | \| |__] | | \| |___ |
7 | | |
8 | | ver 0.9.2 (almost stable) |
9 | |__________________________________________________________|
10 |
--------------------------------------------------------------------------------
/ttbp/config/defaults/footer.txt:
--------------------------------------------------------------------------------
1 |
2 |
