Git Product home page Git Product logo

django-chamber's Introduction

django-chamber

Build Status Codacy Badge Coverage Status Licence

Chamber contains a collection of useful base model classes, form fields, model fields, decorators, or other shortcuts to aid web development in Django.

One can think of it as a toolbox with utilities that were too small to justify creating a standalone library and therefore ended up here. Hence the name Chamber.

Features

The most noteworthy part of Chamber is the alternative base class for Django models called SmartModel. It provides following additional features:

Other useful components include:

  • AuditModel -- adds created_at and changed_at fields to the basic Django model,
  • SmartQuerySet -- adds fast_distinct method to querysets (useful for PostgreSQL),
  • several enum classes such as ChoicesNumEnum or SequenceChoiceEnum,
  • new Django-style shortcuts such as get_object_or_none, change_and_save, or bulk_change_and_save.
  • MigrationLoadFixture class that supports loading Django fixtures inside a database migration
  • ...and more.

Contributing & Documentation

You are welcomed to contribute at https://github.com/druids/django-chamber. There is an example project in the repository. Your feature should be added to this example project with tests as well as the documentation.

  1. Go to the example directory and call make install to install it.
  2. Run tests using make test.

Known Issues

  • documentation of this library is a work in progress, needs a lot of attention
  • SmartModel extends the AuditModel and therefore always adds created_at and changed_at fields to the model which is not always desirable

License

This library is licenced under MIT licence. See the LICENCE file for details.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.