-
Notifications
You must be signed in to change notification settings - Fork 10
/
Copy pathREADME
98 lines (72 loc) · 5.26 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
Title:
django_yaba, aka, django-yet-another-blog-application
Dependencies:
Django-tagging
Python-Feedparser
Python-Twitter
UrlLib and UrlLib2
PIL
setuptools
django-disqus
Demonstration:
You can see the blog in action at http://www.f4ntasmic.com. That version is a bit customized to my exact needs, but it's basically what you'll get when you use this applicaiton.
I know, we didn't have enough blog engines built with Django right? Hell, finding a name for this one was a PITA thanks to all the others ones that exists. Hence, YABA it is. If anyone else already has this, and I just missed it, let me know, and I'll change the name of this one.
Purpose:
I tend to blog a bit (http://www.f4ntasmic.com), and have built my own blog previously using Django. I wanted something a bit more flexible though, so I decided to build it with the idea of being able to plug it anywhere with minimal configuration. I'm going to leverage YAML ( http://www.yaml.de/en/ ) for the theme of the blog, so that you can have a fairly pretty blog out of the box within minutes. Anyways, let me know if you have any questions.
Features:
Dynamic Themes:
There are two "themes" (one is just an ugly hack of the default, intended for test purposes not for actual use) now usable via the Admin UI. The default site configuration is loading from a fixture on initial syncdb, which sets up the initial themes. Obviously that means it's possible to create a theme, put it in the appropriate theme folder, and then create a theme in the Admin panel. You just have to name it the same as your directory in the themes path. Obviously, following my directory structure in the themes will lead to best results.
WYSIWG Editor:
Using TinyMCE
Works
Blog Posts:
Will allow previews for authenticated users eventually. Backburner.
RSS Feed:
They appear to work properly now.. Doesn't work in staging, but it does work on www.f4ntasmic.com for some reason. Same code, different results. I'd try to wrap my head around it, but I fear I'd only hate myself for it.
BlogRoll:
Quite functional. One would hope right? They're flipping links.
Articles:
The articles are items that won't show up in the traditional main news feed. Also, if you check the "Buttoned" box, then the article will have a link to it on the top main nav bar. Currently functional
Comments:
You have the option of using Disqus for comments, or using contrib.comments now. Both work fairly well, so you get
to decide which you prefer. If you want to use contrib's comments, set DJANGO_COMMENTS in your settings.py to true.
Otherwise leave it out, and set you DISQUS settings properly.
Social Media:
Currently can grab your latest tweets, GitHub commits, and builds links to submit stories to Digg, Reddit, Delicious, and StumbleUpon. Github/Twitter configurable via simple settings in settings.py. If you don't want to display your tweets or github commits, just leave those fields empty in settings.py. If those are blank, you'll never see them again.
Search:
You can now search for stories based on title/body contents. It's not super advanced, but it's functional.
Galleries:
You can now add new photo galleries to your site. I've placed a link to the gallery list on the top nav bar for easy browsing of galleries as well. It auto creates thumbnails and links to the full size of the image as well. So far works pretty well, but isn't extensively tested at this time.
Installation Instruction:
YaBa is now intended to be 'pluggable' so that you can easy_install it, and make use of it in your project of choice
as a blog. Currently it's not incredibly well tested as a pluggable, so your mileage may vary. If you do use it and
run into problems PLEASE let me know by submitting an issue or emailing me. I'd love to help resolve any issues you
run into. So right now you can just 'easy_install django-yaba' to install this package. Then you'll need to put the
following variables in your settings.py:
###############################################
# django-yaba specific settings below #
###############################################
# GitHub UserName for sidebar GitHub List - Leave blank if you don't want to use it
GITHUB_USERNAME = 'GITHUB_USER_HOLDER'
# Twitter UserName for sidebar Twitter List and Automatic Tweets
TWITTER_USERNAME = 'TWITTER_USER_HOLDER'
TWITTER_PASSWORD = "TWITTER_PASS_HOLDER"
# Blog Name
BLOG_NAME = 'SITE_NAME_HOLDER'
# Blog URL
ROOT_BLOG_URL = 'http://URL_HOLDER/'
# Root system path
PROJECT_DIR = os.path.dirname(__file__)
# Disqus Settings
DISQUS_API_KEY = "DISQUS_API_HOLDER"
DISQUS_WEBSITE_SHORTNAME = "DISQUS_SHORT_HOLDER"
# If you want to use contrib.comments set the following to True
DJANGO_COMMENTS = False
################################################
Then you'll want to add the following applications to your INSTALLED_APPS:
tagging
disqus
django_yaba
Now you'll sync up your database to setup all of the YaBa tables along with the applications it depends on. Finally
YaBa does have it's own theming that it uses, so I've included in the package all the media that I use on
www.f4ntasmic.com. You'll need to put that in your media path if you want to make use of it. Enjoy!