Skip to content
I'm tired of copy-pasting the same bits of models, over and over between projects, so I'm trying to package up the pieces into a bunch of reusable quasi-components, importable into any Django project.
Python Shell
Find file
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
docs
helpfulfields
.gitignore
LICENSE
MANIFEST.in
README.rst
count_tests.sh
release.sh
requirements.txt
requirements_dev.txt
setup.py
test_settings.py
test_urls.py

README.rst

About django-helpfulfields

Author: Keryn Knight
Status: Alpha

Mostly a collection of Django models, querysets, and admin stuff. Because I'm tired of copy-pasting and tweaking the same bits over and over between projects, so I'm trying to package up the pieces into a bunch of reusable quasi-components, importable into any Django project.

Documentation

Documentation is available via the wonderful Read the docs - the latest build can be found at https://django-helpfulfields.readthedocs.org/en/latest/index.html.

Things it provides

Currently, the following things are provided:

  • Models for:
    • created & modified fields.
    • title & menu title fields.
    • meta title, description and keywords fields.
    • a published boolean field.
    • published date-range fields.
    • pre-set generic foreign key fields.
    • a soft delete field.
  • Querysets for:
    • all the model variants listed above.
  • Admin helpers for:
    • a link on each changelist object to "view on site"
    • a count of related items for an object in the changelist.
    • a list of related items for an object in the changelist.
    • a sparkline of change frequency for an object in the changelist.
  • A whole bunch of strings marked for translation.

Contributing

There is a GitHub repository at kezabelle/django-helpfulfields which is the canonical location for involvement. Use the app. Open issues. Tell me how it could suck less.

Bug reports and feature requests can be filed on the repository's issue tracker.

If something can be discussed in 140 character chunks, there's also my Twitter account.

License

It's FreeBSD. a LICENSE file can be found in the root of the repository, and should also be present in any distributed downloads.

Status

unit tests are now available, via python setup.py test or python manage.py test helpfulfields, which should be slightly re-assuring; there are currently 12 test cases, split into 19 individual tests, which assert 61 variants.

Below is the coverage report from python setup.py test, for the current version:

Name                      Stmts   Miss  Cover   Missing
-------------------------------------------------------
helpfulfields/admin         113      9    92%   163, 290, 302-312, 319-325
helpfulfields/models         94      8    91%   292-297, 308-315
helpfulfields/querysets      39      6    85%   164-165, 175-176, 185-186
helpfulfields/settings        2      0   100%
helpfulfields/text           37      1    97%   9
-------------------------------------------------------
TOTAL                       285     24    92%
Something went wrong with that request. Please try again.