diff --git a/README.html b/README.html index 19a9e47..b5dc943 100644 --- a/README.html +++ b/README.html @@ -1,69 +1,69 @@ -
a command-line based blogging platform running on tilde.town
+a command-line based blogging platform running on tilde.team
-ttbp
stands for “tilde.town blogging platform”, the original working name for
+
ttbp
stands for "tilde.team blogging platform", the original working name for
this project.
ttbp
runs from the command line, providing a hub for writing personal blog
-posts and reading posts written by other users of tilde.town. it’s a little bit
+posts and reading posts written by other users of tilde.team. it's a little bit
like livejournal or dreamwidth or tumblr. you can opt to publish your posts to a
-public html file hosted on your tilde page, to tilde.town’s gopher server, or
-keep all your entries private to the tilde.town server.
to use, run feels
while logged in to tilde.town
to use, run feels
while logged in to tilde.team
this is a project that runs on tilde.town, so all users of this program are
-expected to operate under the tilde.town code of
+ this is a project that runs on tilde.team, so all users of this program are
+expected to operate under the tilde.team code of
conduct. content/personal issues should be
-worked out according to the CoC, with support from the administrative
+worked out according to the CoC, with support from the administrative
team if needed. no coding or html experience is necessary to get started. just log in to your
-tilde.town account and enter:QUICK START
feels
ttbp will ask you a few questions to get you started. after that, writing and reading entries all happen within the program.
-that’s it!
+that's it!
if you’re having trouble getting started, or run into program errors or strange -behavior, please send internal tilde.town mail to ~endorphant and i’ll try to +
if you're having trouble getting started, or run into program errors or strange +behavior, please ask on irc or send a +mail to sudoers@tilde.team and we'll try to sort things out!
-there’s also a function from the main menu that lets you send feedback/inquiries -to me directly; this uses internal tilde.town mail, which is what i’ll respond -to.
+there's also a function from the main menu that lets you send feedback/inquiries +to me directly
entries are recorded as plaintext files in your ~/.ttbp/entries
directory.
ttbp
will use your selected editor to open and write files; each day is its
-own entry, like a diary page. at midnight for whatever timezone you’ve set for
-your user account on tilde.town, you’ll get a fresh entry. if you don’t write
+own entry, like a diary page. at midnight for whatever timezone you've set for
+your user account on tilde.team, you'll get a fresh entry. if you don't write
any feels on a particular day, no entries will show up there.
when you save and quit the text editor, your entry will automatically propagate
-to the global feels list; if you’ve opted to publish your feels to html/gopher,
-those files will update immediately. you can always go back to the current day’s
-entry and edit/add as you’d like, but older entries will not be available for
+to the global feels list; if you've opted to publish your feels to html/gopher,
+those files will update immediately. you can always go back to the current day's
+entry and edit/add as you'd like, but older entries will not be available for
editing from ttbp
.
(since files are just stored as plaintext in your directory, it’s possible to
+ (since files are just stored as plaintext in your directory, it's possible to
edit and move old entries directly from the command line. however, changing old
entries might cause strange things to happen with timestamps. the main program
looks at the filename first for setting the date, then the last modified time to
-sort recent posts. it expects YYYMMDD.txt as the filename; anything else won’t
+sort recent posts. it expects YYYMMDD.txt as the filename; anything else won't
show up as a valid entry. yes, this means you can post things out of date order
by creating files with any date you want.) the you can also pull up a list of a single user’s feels through you can also pull up a list of a single user's feels through please note! entries written on the your subscription list is private; this means no one other than you can see who
-you’re following. subscription view only shows the 50 most recent entries from
+you're following. subscription view only shows the 50 most recent entries from
your subscribe list; if you want to see more entries from an individual, you
can navigate to their entries in `check out your neighbors from the main
menu.reading other feels
browse global feels
feature shows the ten most recent entries that anyone
-has written on ttbp. this list is only accessible from within tilde.town,
+has written on ttbp. this list is only accessible from within tilde.team,
although individual entries may be posted to html or gopher.check out your
+
check out your
neighbors
, which displays all users who are writing on ttbp
based on their
-most recently updated entry, and a link to their public html blog if they’ve
+most recently updated entry, and a link to their public html blog if they've
opted to publish their posts.ttbp
should be considered sensitive,
private information, even if a particular user is publishing entries in a
-world-viewable way! please be respectful about having access to other people’s
+world-viewable way! please be respectful about having access to other people's
feels, and do not copy/repeat any information without getting their explicit
-permission. tilde.town operates on a high level of mutual trust, and ttbp
is
+permission. tilde.team operates on a high level of mutual trust, and ttbp
is
designed to give individuals control over their content.subscribing to users
visit your subscriptions
feature lets you view recent entries from a list
-of users you’ve subscribed to, as well as manage your subscription list. your
+of users you've subscribed to, as well as manage your subscription list. your
list is saved to ~/.ttbp/config/subs
, which gets automatically updated when
you add or remove subscriptions from ttbp.
if you opt to not publish, your entires will never be accessible from outside of
-the tilde.town network; other tilde.town users will still be able to read your
+the tilde.team network; other tilde.team users will still be able to read your
entries through the ttbp interface, or by directly accessing your
~/.ttbp/entries
directory.
if you opt to publish, the program creates a directory ~/.ttbp/www
where it
stores all html files it generates, and symlinks this from your ~/public_html
-with your chosen blog directory. your blog will also be listed on the main ttbp
-page.
you can also opt to publish to gopher, and the program will automatically generate a gophermap of your feels.
you can set publishing status on individual entries, or bury individual feels; -see “data management” below for details.
+see "data management" below for details.(nopub)
will not get written to html or gopher,
and toggling them from this menu will immediately publish or unpublish
-that entry (if you’re not publishing your posts at all, these settings
-won’t matter, since your feels will never show up outside of tilde.town)~/.ttbp/backups/
with the current date, and a second copy to
your home directory for safekeeping.~/.ttbp/backups
directory for archives, and
expects a file created by the above backup utility. if it detects any file
collisions, it will preserve your current live copy and leave the backup
verison in a temp directory, and notify you that this happened. also, any
entries that were previously marked as (nopub)
will retain their nopub
status.~/.ttbp/buried
(and marked with a unique timestamp to prevent
file collision) with permissions set to 600, meaning no one except you
will be able to open that file. these entries are also hidden from your
-own view from read over feels
, and you’ll have to open the files from
+own view from read over feels
, and you'll have to open the files from
the command line if you want to see them. this is intended to be a
-permament action, so you’ll be asked to type the entry date once to load
+permament action, so you'll be asked to type the entry date once to load
the feel, then shown a preview of that feel, and then type the date again
to confirm burying.~/.ttbp
directory. any backups that you have in ~/.ttbp/backups
will also be deleted with this action (which is why the backup function
@@ -183,25 +181,23 @@ makes a second copy for safekeeping in your home directory). you will no
longer show up in any lists as a user.the settings menu lets you change specific options for handling your feels and using the interface.
public_html
where feels will be
-published (if you’re not publishing your feels, this defaults to None
)public_html
where feels will be
+published (if you're not publishing your feels, this defaults to None
)you can modify how your blog looks by editing the stylesheet or header and
@@ -213,28 +209,24 @@ your ~/.ttbp directory entirely. you might want to back up your
these are a few ideas being kicked around, or under active development: other ideas are listed on github as
upcoming features or feature requests!
-
-general tips/troubleshooting
-
-
future features
please check out my contributor guidelines -on github if you’d like to get involved with development!
+on github if you'd like to get involved with development!if you find any bugs or strange behavior, please message me locally on tildemail -or open a github issue and i’ll get back to you as soon as i can.
+or open a github issue and i'll get back to you as soon as i can. -if you’re interested in helping with the code, please drop me some tildemail!
+if you're interested in helping with the code, please drop me some tildemail!
i accept tips for development work on liberapay
@@ -283,5 +273,5 @@ or open a github issue and i’ll get back to you as soon as i can.ttbp
stands for "tilde.town blogging platform", the original working name for
+
+
ttbp
stands for "tilde.team blogging platform", the original working name for
this project. the complete codebase is available on
-github.
ttbp
runs from the command line, providing a hub for writing personal blog
-posts and reading posts written by other users of tilde.town. it's a little bit
+posts and reading posts written by other users of tilde.team. it's a little bit
like livejournal or dreamwidth or tumblr. you can opt to publish your posts to a
-public html file hosted on your tilde page, to tilde.town's gopher server, or
-keep all your entries private to the tilde.town server.
this is a project that runs on tilde.town, so all users of this program are -expected to operate under the tilde.town code of +public html file hosted on your tilde page, to tilde.team's gopher server, or +keep all your entries private to the tilde.team server.
+ +this is a project that runs on tilde.team, so all users of this program are +expected to operate under the tilde.team code of conduct. content/personal issues should be -worked out according to the CoC, with support from the administrative +worked out according to the CoC, with support from the administrative team if needed.
+if you're having trouble getting started, or run into program errors or strange -behavior, please send internal tilde.town mail to ~endorphant and i'll try to +behavior, please ask on #team or send a mail +to sudoers@tilde.team and we'll try to sort things out!
+there's also a function from the main menu that lets you send feedback/inquiries -to me directly; this uses internal tilde.town mail, which is what i'll respond -to.
+to us directly +entries are recorded as plaintext files in your ~/.ttbp/entries
directory.
ttbp
will use your selected editor to open and write files; each day is its
own entry, like a diary page. at midnight for whatever timezone you've set for
-your user account on tilde.town, you'll get a fresh entry. if you don't write
+your user account on tilde.team, you'll get a fresh entry. if you don't write
any feels on a particular day, no entries will show up there.
when you save and quit the text editor, your entry will automatically propagate
to the global feels list; if you've opted to publish your feels to html/gopher,
those files will update immediately. you can always go back to the current day's
entry and edit/add as you'd like, but older entries will not be available for
editing from ttbp
.
(since files are just stored as plaintext in your directory, it's possible to edit and move old entries directly from the command line. however, changing old entries might cause strange things to happen with timestamps. the main program @@ -37,134 +47,164 @@ looks at the filename first for setting the date, then the last modified time to sort recent posts. it expects YYYMMDD.txt as the filename; anything else won't show up as a valid entry. yes, this means you can post things out of date order by creating files with any date you want.)
+<!-- comments -->
to have them show up
- in the feed but not render in a browser (but people can still read them with
- view-source)the browse global feels
feature shows the ten most recent entries that anyone
-has written on ttbp. this list is only accessible from within tilde.town,
+has written on ttbp. this list is only accessible from within tilde.team,
although individual entries may be posted to html or gopher.
you can also pull up a list of a single user's feels through check out your
neighbors
, which displays all users who are writing on ttbp
based on their
most recently updated entry, and a link to their public html blog if they've
opted to publish their posts.
please note! entries written on ttbp
should be considered sensitive,
private information, even if a particular user is publishing entries in a
world-viewable way! please be respectful about having access to other people's
feels, and do not copy/repeat any information without getting their explicit
-permission. tilde.town operates on a high level of mutual trust, and ttbp
is
+permission. tilde.team operates on a high level of mutual trust, and ttbp
is
designed to give individuals control over their content.
when you start your ttbp, you have the option of publishing or not publishing your blog.
+if you opt to not publish, your entires will never be accessible from outside of
-the tilde.town network; other tilde.town users will still be able to read your
+the tilde.team network; other tilde.team users will still be able to read your
entries through the ttbp interface, or by directly accessing your
~/.ttbp/entries
directory.
if you want to further protect your entries, you can chmod 700
your entries
directory.
if you opt to publish, the program creates a directory ~/.ttbp/www
where it
stores all html files it generates, and symlinks this from your ~/public_html
-with your chosen blog directory. your blog will also be listed on the main ttbp
+with your chosen blog directory. your blog will also be listed on the main ttbp
page.
you can also opt to publish to gopher, and the program will automatically generate a gophermap of your feels.
+you can set publishing status on individual entries, or bury individual feels; see "data management" below for details.
+the manage your feels
menu provides several tools for organizing your feels.
these are all actions you can perform manually from the command line, but doing
them from within the program can help keep your files properly linked up.
(nopub)
will not get written to html or gopher,
- and toggling them from this menu will immediately publish or unpublish
- that entry (if you're not publishing your posts at all, these settings
- won't matter, since your feels will never show up outside of tilde.town)(nopub)
will not get written to html or gopher,
+and toggling them from this menu will immediately publish or unpublish
+that entry (if you're not publishing your posts at all, these settings
+won't matter, since your feels will never show up outside of tilde.team)
~/.ttbp/backups/
with the current date, and a second copy to
- your home directory for safekeeping.~/.ttbp/backups/
with the current date, and a second copy to
+your home directory for safekeeping.
~/.ttbp/backups
directory for archives, and
- expects a file created by the above backup utility. if it detects any file
- collisions, it will preserve your current live copy and leave the backup
- verison in a temp directory, and notify you that this happened. also, any
- entries that were previously marked as (nopub)
will retain their nopub
- status.~/.ttbp/backups
directory for archives, and
+expects a file created by the above backup utility. if it detects any file
+collisions, it will preserve your current live copy and leave the backup
+verison in a temp directory, and notify you that this happened. also, any
+entries that were previously marked as (nopub)
will retain their nopub
+status.
~/.ttbp/buried
(and marked with a unique timestamp to prevent
- file collision) with permissions set to 600, meaning no one except you
- will be able to open that file. these entries are also hidden from your
- own view from read over feels
, and you'll have to open the files from
- the command line if you want to see them. this is intended to be a
- permament action, so you'll be asked to type the entry date once to load
- the feel, then shown a preview of that feel, and then type the date again
- to confirm burying.~/.ttbp/buried
(and marked with a unique timestamp to prevent
+file collision) with permissions set to 600, meaning no one except you
+will be able to open that file. these entries are also hidden from your
+own view from read over feels
, and you'll have to open the files from
+the command line if you want to see them. this is intended to be a
+permament action, so you'll be asked to type the entry date once to load
+the feel, then shown a preview of that feel, and then type the date again
+to confirm burying.
~/.ttbp
directory. any backups that you have in ~/.ttbp/backups
- will also be deleted with this action (which is why the backup function
- makes a second copy for safekeeping in your home directory). you will no
- longer show up in any lists as a user.~/.ttbp
directory. any backups that you have in ~/.ttbp/backups
+will also be deleted with this action (which is why the backup function
+makes a second copy for safekeeping in your home directory). you will no
+longer show up in any lists as a user.
the settings menu lets you change specific options for handling your feels and using the interface.
+public_html
where feels will be
- published (if you're not publishing your feels, this defaults to None
)None
)
you can modify how your blog looks by editing the stylesheet or header and footer files. the program sets you up with basic default. if you break your page somehow, you can force the program to regenerate your configuration by deleting your ~/.ttbp directory entirely. you might want to back up your ~/.ttbp/entries directory before you do this.
+these are a few ideas being kicked around, or under active development:
+less
)other ideas are listed on github as -upcoming features or feature requests!
\ No newline at end of file +upcoming features or feature requests! diff --git a/doc/manual.md b/doc/manual.md index a09ec22..8d96513 100644 --- a/doc/manual.md +++ b/doc/manual.md @@ -1,37 +1,37 @@ -# FEELS MANUAL # +# FEELS MANUAL -`ttbp` stands for "tilde.town blogging platform", the original working name for +`ttbp` stands for "tilde.team blogging platform", the original working name for this project. the complete codebase is available on -[github](https://github.com/modgethanc/ttbp). +[tildegit](https://tildegit.org/team/ttbp). `ttbp` runs from the command line, providing a hub for writing personal blog -posts and reading posts written by other users of tilde.town. it's a little bit +posts and reading posts written by other users of tilde.team. it's a little bit like livejournal or dreamwidth or tumblr. you can opt to publish your posts to a -public html file hosted on your tilde page, to tilde.town's gopher server, or -keep all your entries private to the tilde.town server. +public html file hosted on your tilde page, to tilde.team's gopher server, or +keep all your entries private to the tilde.team server. -this is a project that runs on tilde.town, so all users of this program are -expected to operate under the tilde.town [code of -conduct](http://tilde.town/wiki/conduct.html). content/personal issues should be +this is a project that runs on tilde.team, so all users of this program are +expected to operate under the tilde.team [code of +conduct](http://tilde.team/wiki/code-of-conduct). content/personal issues should be worked out according to the CoC, with support from the [administrative -team](http://tilde.town/wiki/administration/index.html) if needed. +team](https://tilde.team/wiki/code-of-conduct#9--contact-info) if needed. ### support if you're having trouble getting started, or run into program errors or strange -behavior, please send internal tilde.town mail to ~endorphant and i'll try to +behavior, please ask on [#team](https://web.tilde.chat/?join=team) or send a mail +to [sudoers@tilde.team](mailto:sudoers@tilde.team) and we'll try to sort things out! there's also a function from the main menu that lets you send feedback/inquiries -to me directly; this uses internal tilde.town mail, which is what i'll respond -to. +to us directly ### writing entries entries are recorded as plaintext files in your `~/.ttbp/entries` directory. `ttbp` will use your selected editor to open and write files; each day is its own entry, like a diary page. at midnight for whatever timezone you've set for -your user account on tilde.town, you'll get a fresh entry. if you don't write +your user account on tilde.team, you'll get a fresh entry. if you don't write any feels on a particular day, no entries will show up there. when you save and quit the text editor, your entry will automatically propagate @@ -59,7 +59,7 @@ by creating files with any date you want.)* ### reading other feels the `browse global feels` feature shows the ten most recent entries that anyone -has written on ttbp. this list is only accessible from within tilde.town, +has written on ttbp. this list is only accessible from within tilde.team, although individual entries may be posted to html or gopher. you can also pull up a list of a single user's feels through `check out your @@ -71,7 +71,7 @@ opted to publish their posts. private information, even if a particular user is publishing entries in a world-viewable way! please be respectful about having access to other people's feels, and do not copy/repeat any information without getting their explicit -permission. tilde.town operates on a high level of mutual trust, and `ttbp` is +permission. tilde.team operates on a high level of mutual trust, and `ttbp` is designed to give individuals control over their content. ### privacy @@ -80,7 +80,7 @@ when you start your ttbp, you have the option of publishing or not publishing your blog. if you opt to not publish, your entires will never be accessible from outside of -the tilde.town network; other tilde.town users will still be able to read your +the tilde.team network; other tilde.team users will still be able to read your entries through the ttbp interface, or by directly accessing your `~/.ttbp/entries` directory. @@ -90,7 +90,7 @@ directory. if you opt to publish, the program creates a directory `~/.ttbp/www` where it stores all html files it generates, and symlinks this from your `~/public_html` with your chosen blog directory. your blog will also be listed on the [main ttbp -page](https://tilde.town/~endorphant/ttbp). +page](https://tilde.team/~ben/ttbp). you can also opt to publish to gopher, and the program will automatically generate a gophermap of your feels. @@ -110,7 +110,7 @@ them from within the program can help keep your files properly linked up. posts. entries marked `(nopub)` will not get written to html or gopher, and toggling them from this menu will immediately publish or unpublish that entry (if you're not publishing your posts at all, these settings - won't matter, since your feels will never show up outside of tilde.town) + won't matter, since your feels will never show up outside of tilde.team) * **backup your feels**--makes a .tar.gz of all your entries, saving one copy to `~/.ttbp/backups/` with the current date, and a second copy to your home directory for safekeeping. diff --git a/setup.py b/setup.py index 5fb662a..6b87c47 100644 --- a/setup.py +++ b/setup.py @@ -5,8 +5,8 @@ from setuptools import setup setup( name='ttbp', version='0.12.2', - description='command line social blogging tool used on tilde.town', - url='https://github.com/modgethanc/ttbp', + description='command line social blogging tool used on tilde.team', + url='https://tildegit.org/team/ttbp', author='~endorphant', author_email='endorphant@tilde.town', license='MIT', diff --git a/ttbp/chatter.py b/ttbp/chatter.py index ed2bbda..d2d7188 100644 --- a/ttbp/chatter.py +++ b/ttbp/chatter.py @@ -16,7 +16,7 @@ DEFAULT_LANG = { ], "bye":[ "see you later, space cowboy", - "bye, townie", + "bye, teammate", "until next time, friend", "come back whenever" ], @@ -24,7 +24,7 @@ DEFAULT_LANG = { "friend", "pal", "buddy", - "townie" + "teammate" ], "months":{ "01":"january", diff --git a/ttbp/config/__init__.py b/ttbp/config/__init__.py index 9a9d5d2..30b96b2 100644 --- a/ttbp/config/__init__.py +++ b/ttbp/config/__init__.py @@ -3,7 +3,7 @@ import os import sys import time -from .. import util +import ttbp.util ## System config @@ -24,8 +24,8 @@ if not os.path.isdir(VAR): if not os.path.isdir(VAR_WWW): os.mkdir(VAR_WWW) -LIVE = 'https://tilde.town/~' -FEEDBOX = "endorphant@tilde.town" +LIVE = 'https://tilde.team/~' +FEEDBOX = "sudoers@tilde.team" USERFILE = os.path.join(VAR, "users.txt") GRAFF_DIR = os.path.join(VAR, "graffiti") WALL = os.path.join(GRAFF_DIR, "wall.txt") @@ -45,7 +45,7 @@ DEFAULT_HEADER = '''""") diff --git a/ttbp/gopher.py b/ttbp/gopher.py index 17f02a3..a671faa 100644 --- a/ttbp/gopher.py +++ b/ttbp/gopher.py @@ -6,9 +6,8 @@ import os import time import subprocess -from . import util -from . import config -#from .core import parse_date +import util +import config GOPHER_PROMPT = """ @@ -41,7 +40,7 @@ GOPHERMAP_HEADER = """ this file is automatically generated by ttbp. -0(about ttbp)\t/~endorphant/ttbp.txt\ttilde.town\t70 +0(about ttbp)\t/ttbp.txt\ttilde.team\t70 1(back to user's home)\t/~{user} entries: diff --git a/ttbp/ttbp.py b/ttbp/ttbp.py index 7df3f6e..4b27bae 100644 --- a/ttbp/ttbp.py +++ b/ttbp/ttbp.py @@ -30,6 +30,8 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. the complete codebase is available at: https://github.com/modgethanc/ttbp +and +https://tildegit.org/team/ttbp ''' from __future__ import absolute_import @@ -45,11 +47,11 @@ from six.moves import input import inflect -from . import config -from . import core -from . import chatter -from . import gopher -from . import util +import config +import core +import chatter +import gopher +import util __version__ = "0.12.2" __author__ = "endorphant