Mercurial > hg > bitsyblog

comparison README.txt @ 0:e3823be6a423

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
initial commit of bitsyblog, from https://svn.openplans.org/svn/standalone/bitsyblog/trunk/
author k0s <k0scist@gmail.com>
date Sat, 12 Sep 2009 16:06:57 -0400
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:e3823be6a423
1 bitsyblog
2 =========
3
4 *bitsyblog doesn't do much, but it could do less*
5
6
7 Why another blog?
8 -----------------
9
10 My ideal blog would invoke my favorite editor, take a bunch of text, and
11 throw it on the web. Sometimes I like to write long elaborate posts.
12 Othertimes I just want to make a quick note.
13
14 Meet `bitsyblog <http://bitsyblog.biz>`_,
15 a tiny tiny `python <http://python.org/>`_
16 `weblog <http://pypi.python.org/pypi/bitsyblog/>`_.
17 Posting is done with a POST request, so while you can use
18 a web form to do this, its just as easy to use curl, urllib, or anything else
19 to post.
20
21
22 How does it work?
23 -----------------
24
25 A user URLs is like
26
27 http://bitsyblog.biz/k0s
28
29 k0s is my user name here . If you are 1337h4x0r, this will be
30 http://bitsyblog.biz/1337h4x0r .
31 Posting to this will take the body of the POST request and add a date stamp
32 Blog entries are thrown in files and are displayed with markup
33 available with `restructured text
34 <http://docutils.sourceforge.net/docs/user/rst/quickref.html>`_.
35
36 You can also get a more specific range of posts
37 by specifying up to the year, month
38 and day in the URL:
39
40 http://bitsyblog.biz/k0s/2008/2/1
41
42 Not all of this needs to be specified.
43
44 Permalinks are also available in the form of the date stamp:
45
46 http://bitsyblog.biz/k0s/20080201141502
47
48 You can find the permalink by clicking on the subject of the blog post.
49
50 If you really want to post through the web, support is at
51
52 http://bitsyblog.biz/k0s/post
53
54 If you're more friendly with python scripts,
55 `blogme.py <https://svn.openplans.org/svn/standalone/bitsyblog/trunk/blogme.py>`_
56 is available:
57 https://svn.openplans.org/svn/standalone/bitsyblog/trunk/blogme.py
58
59
60 Get me a blog!
61 --------------
62
63 Create an account at http://bitsyblog.biz/join . All you need is a
64 username and password (and I threw a
65 `CAPTCHA <http://skimpygimpy.sourceforge.net/>`_ in there at some
66 point).
67 Then...you're ready to blog! The auth is a minimal thing
68 I threw together out of `paste.auth <http://pythonpaste.org/>`_.
69
70 Once you're signed in, you'll notice the navigation links at the top
71 of the page have changed. You can now post and change your preferences.
72
73 In your preferences, you can change the date format and set the
74 subject format of your blog posts. You can also upload
75 verifiable CSS to theme your blog. For the date format, I have patched
76 `dateutil.parser <http://labix.org/python-dateutil>`_
77 to return the format string that the date was originally in and hope
78 that my changes can make it back to the source sometime.
79
80 When posting, you have the option to make your post 'public' (everyone
81 can see it), 'secret' (only your friends can see it), 'private' (only
82 you can see it. Friends are settable in your preferences.
83
84
85 What bitsyblog doesn't do
86 -------------------------
87
88 * Commenting: this should done with
89 `WSGI middlware
90 <http://groovie.org/articles/2005/10/06/wsgi-and-wsgi-middleware-is-easy>`_.
91 There's nothing specific about commenting on a blog post that is any
92 different from commenting on a paragraph in (for instance) a wiki article.
93
94 * Tagging: again, this should be done with middleware
95
96 * Hosting files: Its a blog, not a file repo! Any markup doable with
97 `restructured text <http://docutils.sourceforge.net/rst.html>`_
98 is doable with bitsyblog, but images, videos, whatever must
99 be held off-site.
100
101
102 What is next for bitsyblog?
103 ---------------------------
104
105 Other than that, its a pretty small project. No templates and
106 currently about 700 lines of code. (I'll get it back to 500, I
107 swear). bitsyblog is designed as a personal blog that should be strong
108 in both workflow as well as "niceness" of code.
109
110 I'm guessing your blog doesn't do much...but could it do less?
111
112
113 bitsyblog is built on top of `paste <http://pythonpaste.org/>`_
114 and `webob <http://pythonpaste.org/webob/>`_. You'll need the
115 trunk version of paste for a change made to
116 `paste.auth.auth_tkt
117 <http://svn.pythonpaste.org/Paste/trunk/paste/auth/auth_tkt.py>`_
118 in order to have cookies work correctly (r7261).
119
120 Thanks to `The Open Planning Project <http://www.openplans.org>`_
121 and my friends there for making this possible.
122
123 Please email jhammel at openplans dot org with any questions.
124