Skip to content

Latest commit

 

History

History
88 lines (64 loc) · 2.86 KB

README.rst

File metadata and controls

88 lines (64 loc) · 2.86 KB
Raw

https://secure.travis-ci.org/yourlabs/django-appstore.png?branch=master

django-appstore

Status: alpha / research software, subject to full rewrite for version 1.0.

Intended audience: experienced django web developers, the installation procedure contains many steps to fail and require a lot of care.

Features

This app intends to provide a simple appstore for django. It is inspired by both Chrome App Store and uses the concept of Environment like Python's brilliant virtualenv.

It is left to the user of this app to connect post_app_install and post_app_uninstall, because this app is just a helper to make your own app system. It is actually made for our specific needs so you might prefer to edit it rather than to try to use it as-is.

Templates and staticfiles use twitter bootstrap and jQuery.

Install

  • install sources from github with pip install -e git+....,
  • install models by adding appstore to INSTALLED_APPS and run syncdb or migrate,
  • include urls by adding url(r'appstore/', include('appstore.urls')) to urls.py,
  • install appstore.middleware.EnvironmentMiddleware to begin with, you might want to replace it with your own implementation later though,
  • install templates by overriding appstore/base.html to customize the parent template and blocks,
  • if you have problems with static files, rely on Django's documentation or YourLabs blog article which is shorter,
  • bind javascript signals, you can copy the js from test_project/templates/site_base.html to begin with,
  • implement post_app_install and post_app_uninstall signals like you want.

Documentation / design

Models

  • App model represents an app,
  • AppFeature has just a name, and represents a feature of an App in App.provides, or a feature that an App requires in App.requires,
  • AppCategory model allows to sort App by category in AppCategoryView,
  • Environment model keeps track of installed apps,

App and AppCategory are dumb models used to build a catchy Chrome App Store-like frontend. App, AppFeature and Environment are used to build the Pythonic package management backend.

Python Signals

post_app_install
Triggered when an app is installed into an environment.
post_app_uninstall
Triggered when an app is uninstalled from an environment.

Javascript signals

You can see an example implementation of javascript slots in test_project/templates/site_base.html.

appstore.app.action
Triggered when an app is installed or uninstalled successfully.
appstore.app.error
Triggered when an app failed to install or uninstall.
appstore.app.require_env
Triggered when the user clicked to install an app, but has no environment selected in his sesession, ie. not authenticated.

Editable apps