A python auto-scaffolding tool for MVC applications like Django.
Python HTML
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

MIT Badge Donation badge

Skaffold

Providing auto-scaffolding for your web applications!

How does it work?

By using the wonderful Jinja2 templating engine, the output of a standard python web application is rendered via JSON config. There is also support for inflection, and it provides a few extra features out of the box:

  • Model factories via Factory Boy
  • Test definitions with standard CRUD testing and input testing.
  • Models, Views Controllers and Routers (urls, in django)
  • Templating:
    • Any arbitrary static page
    • Form partials for CRUD operations
    • Model and Collection views for groups of models or model details
    • Multiple display types in collection views (e.g. table, list, etc...)
  • (Django) custom commands for fixture generation python manage.py generate_fixtures
  • Typical app structure:
    • CSS, JS and image folder, with app/vendor subfolders.
  • Bootstrap-3 styling/integration.
  • Django bootstrap-3 integration.

Who is it for?

Skaffold is simple and opinionated. It provides very vanilla layout options, so it's meant for those who either:

  1. Want the boilerplate setup complete, to style and improve upon.
  2. Non web-app developers who want an app up and running quickly.
  3. Mechanization of any sort, for auto-generating applications.

Using the command line interface (recommended)

A script to load your json file and configuration is provided by cli.py. To use, just run python cli.py --json **yourfile.json**

See the cli for more details. All options provided by cli arguments:

  • --noserve: do not serve the django application after building
  • --json: required to use a json configuration file.

Dependencies

All

  • inflection
  • jinja

Django

  • django-bootstrap
  • factory boy

Current support

Django

Currently implemented.

Flask

TBD

JSON Config options:

See defaults.json and example.json for details and best examples.

  • upload_dir: the main directory/path to use when storing uploads in model forms. This is always a sub-directory of static_root (Django)
  • static_root: the path for all static assets (Django)
  • media_url: the subdirectory for media, used in collectstatic. (Django)
  • absolute_path: The absolute path to save all files and folders. Supports ~ to indicate the home directory.
  • project_root: the name of your primary application parent project
  • app_name: the name of your individual application
  • use_admin: (bool) - enable/disable admin (Django)
  • export: (bool) - enable/disable exporting of models from view (Django)
  • export_options: (list) - Acceptable serialized export options. Options are xml, json, and yaml.
  • staticpages_in_nav: (bool) - whether or not to render the staticpage links in the primary navigation

A note on uploads and static media (django)

Uploads are always stored by django in the MEDIA_ROOT directory, which is under STATIC_ROOT, and then stored wherever specified in the upload_to kwarg in your model form. To use this path easily, simply add:

{% static 'media' %}/{{ model.filename_property }} in your template.

Model Config

  • display_as: how to show a given collection of models on the list (collection) page. Options "table", "list", or "panel" (boostrap 3) are supported.
  • classes: class list (list) - a list of classes to apply to the html representation
  • data_attrs: attrs list (list) - a list of data attributes to apply to the html representation

Specifying property types

Types are inferred by default, but a few must be specified. To avoid making configuration extra work, simple "flags" are specified in place of the equivalent, verbose property:

  • __M2M__: specifes the Many2Many relationship, with the model (e.g. "model": "_M2M_") (Django)
  • __FILE__: specifies that the property should be a FileField (Django)
  • __DATE__: specifies that the property should be a DateTimeField (Django)

Static assets

CSS/JSS

  • active: (boolean) - if custom css should be shown in base template
  • libs: (list) - a list of names of libraries to add
  • external_libs: (list) - a list of urls to external libraries to add (always comes before app libraries)

CSS

  • bootstrap:
    • fluid: (boolean) - use fluid container or not (bootstrap 3, Django)
    • form_display: (string) - how to display the form, using bootstrap form styles. Options are horizontal or inline. See bootstrap for examples and django-bootstrap3 for the actual implementation.
    • default_btn_size: (string) - the default button size for all plainly rendered buttons in the template. See bootstrap buttons for more details.

Staticpages:

  • title: filename: a key/value list of static pages, where key = title, value = filename
  • static_pages_filetype: the filetype to use for static pages (e.g html, hbs, templ, etc...). Do not add a dot.

Models:

  • modelname, {key: val, key: val} (map) - a model name, with child key/value pairs for each model property and value.

TODO:

  • More support beyond django (Flask, etc...)
  • Better abstraction
  • More robust plug-in support/api (to prevent losing focus, and overloading the project).

More/Similar

Not meeting your needs? Submit an issue, or consider looking at something like CookieCutter, and/or CookieCutter-Django.