Welcome to django-nano’s documentation!¶
Does less!
This is a set of nano-size tools and apps for Django 1.4 and later.
Contents:
Installation¶
Thanks for downloading django-nano.
Install via - unpacking and running ‘python setup.py install’ - pip install django-nano - easy_install django-nano
These tools and applications require Python 2.6 or later, and Django 1.3 or later. You can obtain Python from http://www.python.org/ and Django from http://www.djangoproject.com/.
This version will run on Django 1.3 if you rewrite the templates (search for {% url ‘) and Django 1.4 and newer otherwise.
Usage¶
Common for all apps¶
Append nano.<subapp> to your INSTALLED_APPS, where subapp
is any of the tools listed above except tools.
Check the docs for the apps themselves for anything app-specific.
Specific apps¶
activation¶
A place to store activation-codes for e.g. authentication
-
nano.activation.baseNgenerator(base=10, keylength=5, step=1)¶ Generate keys of base <base> and length <keylength>
-
nano.activation.generate_keys(generator, amount=50)¶ Generate <amount> keys with <generator>
-
nano.activation.to_base(num, base, numerals='0123456789abcdefghijklmnopqrstuvwxyz')¶ Convert <num> to <base> using the symbols in <numerals>
Models¶
badge¶
User-badges worth certain points ala. StackOverflow
-
nano.badge.add_badge(badge, model)¶ Put a badge on a model
-
nano.badge.batchbadge(badge, queryset)¶ Put a badge on all models that do not already have the badge
Models¶
blog¶
A very basic blog-app.
It is also possible to convert from
django-tagging to django-taggit using the management command
migrate_tagging_to_taggit. This will convert all tags, not
just those for blog entries.
Models¶
Tools¶
Changes to settings¶
- NANO_BLOG_USE_TAGS (optional)
Set to True to use django-taggit or django-tagging if either is installed.
django-taggitwill be preferred if both are installed.Default: Not set
- NANO_BLOG_SPECIAL_TAGS (optional)
A list of tags that may be treated specially.
Default:
('pinned',)
chunk¶
A chunk is a template that is stored in the database.
It has a unique name, the slug, and some content, which is whatever
you’d put in an ordinary template.
You use it by setting the template_name to the slug of the chunk, or by {% include %}-ing it directly.
If the chunk uses non-builtin template tags, remember to {% load %} the template tag library in the chunk.
There’s a model and a template loader:
Models¶
Chunks can be created, updated and deleted via the django admin.
Changes to settings¶
Add 'nano.chunk.loader.Loader' to TEMPLATE_LOADERS.
countries¶
Drop-in, nanofied replacement for https://code.google.com/p/django-countries/ .
To use: import from nano.countries instead of countries. The
primary key is the two-letter iso country code, name and
printable_name points to the same thing: what was known as
printable_name in django-countries.
There is an admin, there are no template tags, views, forms or fields.
Models¶
tools¶
Utility-functions used by some of the other apps.
Template tags¶
Either import the tags into some other templatetags-library. or add
'nano.tools' to INSTALLED_APPS.
user¶
Doesn’t have any models so just hook up the views in an urls.py:
signup()password_change()password_reset()
Changes to settings¶
- NANO_USER_EMAIL_SENDER
The From:-address on a password-reset email. If unset, no email is sent.
Default: Not set
- NANO_USER_TEST_USERS
Special-cased usernames for live testing.
Default:
()- NANO_USER_BLOG_TEMPLATE
Template used for auto-blogging new users.
Default:
blog/new_user.html