Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/agiliq/mason

Generate the starting point for your Django project
https://github.com/agiliq/mason

Last synced: 11 days ago
JSON representation

Generate the starting point for your Django project

Awesome Lists containing this project

README

        

-------------
Django-Mason
-------------

|TravisCI|_

.. |TravisCI| image:: https://api.travis-ci.org/agiliq/mason.png?branch=master
.. _TravisCI: https://travis-ci.org/agiliq/mason

Django-Mason is a service that allows you to generate django project templates
easily.

---
Why
---

Every project is different, so why start a new project with the same template?

``django-mason.py`` lets you pick and choose the components you need and
configures them for you so you can start your project easy and clean.

--------
Install
--------

``pip install -e git+git://github.com/agiliq/mason.git#egg=django-mason``

-----
Usage
-----

Generate a project template named mytemplate:

``django-mason.py generate mytemplate``

Now this template can be used as:

``django-admin.py startproject myproject --template=mytemplate``

To do this in one step:

``django-mason.py startproject myproject``

Plugins aka Bricks
---------------------

Work in progress...

* Database ✓
* Admin ✓
* South ✓
* Django Debug Toolbar ✓
* Fabric ✓
* Sentry ✓
* Parsley ✓
* Travis ✓
* Merchant
* Nose
* Piston
* Tastypie
* Rest-framework
* Userena
* Guardian
* Django-CMS
* Fein-CMS
* Mezzanine
* Disqus ✓
* Django-Extensions
* Grapelli ✓
* uni-form
* crispy-forms ✓

Writing new Bricks
-------------------

To new apps, you need to create a new class which extends from
``mason.bricks.base.BaseBrick``. See the existing apps for options which can be
overriden here.

-------
Roadmap
-------

* Maybe have a web UI

------------
Inspiration
------------

* Yeoman_
* initializr_

.. _Yeoman: http://yeoman.io/
.. _initializr: http://www.initializr.com/