Skip to content

Make the README file more beautiful. #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
liushuaikobe wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Make the README file more beautiful. #6

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cb6d95a
convert the readme txt to md
liushuaikobe Sep 25, 2013
cba61f1
add the python code render to readme
liushuaikobe Sep 25, 2013
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 14 additions & 8 deletions README.txt → README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,24 +1,28 @@
django-singletons
============================================

I keep finding myself re-using this simple bit of code, so I thought I should open-source it, even though it's not much more than a snippet.

A SingletonModel is a django model that only ever has one record. You can't use the admin to create a new instance, or delete the existing one.

Some might argue that singleton models are an inefficient way of using a relational database, but in practice it's no biggie - most web sites have some important one-off content (eg. the Home Page), and singleton models map well to how content editors generally think.

I suspect I have cadged some of this code from someone else (likely ex-colleague http://github.com/jphalip/), but a quick Google doesn't show up anything like this already out there. So here it is. I hope you find it useful.
I suspect I have cadged some of this code from someone else (likely ex-colleague [http://github.com/jphalip/](http://github.com/jphalip/)), but a quick Google doesn't show up anything like this already out there. So here it is. I hope you find it useful.

Installation
------------
```
$ pip install django-singletons
```

pip install django-singletons

To get the custom admin templates working, you need to add "singleton_models" to your INSTALLED_APPS
To get the custom admin templates working, you need to add `singleton_models` to your `INSTALLED_APPS`

Example Usage
-------------

in models.py

in `models.py`

``` python
from singleton_models.models import SingletonModel

class HomePage(SingletonModel):
Expand All @@ -30,11 +34,13 @@ class HomePage(SingletonModel):
class Meta:
verbose_name = "Home Page" # once again this will make sure your admin UI doesn't have illogical text
verbose_name_plural = "Home Page"
```

in `admin.py`

in admin.py

``` python
from singleton_models.admin import SingletonModelAdmin
from models import HomePage

admin.site.register(HomePage, SingletonModelAdmin)
```