README.rst 1.82 KB
Newer Older
Jasper St. Pierre's avatar
Jasper St. Pierre committed
1 2 3 4 5 6 7
==============
SweetTooth-Web
==============

**SweetTooth-Web** is a Django-powered web application that, in co-operation
with some co-horts in GNOME Shell and other places, allows users to install,
upgrade and enable/disable their own Shell Extensions. All operations with
8 9
the Shell are done through a special NPAPI plugin, sweettooth-plugin_, which
proxies over to the Shell by DBus.
Jasper St. Pierre's avatar
Jasper St. Pierre committed
10 11 12 13 14 15

Since extensions can be dangerous, all extensions uploaded to the repository
must go through code review and testing.

.. _sweettooth-plugin: https://github.com/magcius/sweettooth-plugin

16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33
Getting Started
---------------

  $ git clone git://github.com/magcius/sweettooth.git
  $ cd sweettooth
  $ virtualenv_ --no-site-packages ./venv
  $ . ./venv/bin/activate
  $ pip_ install -r requirements.txt
  $ # ... Database setup...
  $ python sweettooth/manage.py runserver_plus

Create a superuser, and log in. You should be able to upload extensions and
review extensions. There isn't a link to the code review UI, but it's hidden
at /review/.

.. _virtualenv: http://www.virtualenv.org/
.. _pip: http://www.pip-installer.org/

Jasper St. Pierre's avatar
Jasper St. Pierre committed
34 35 36 37 38 39 40
Requirements
------------

  * django_
  * django-autoslug_
  * django-extensions_
  * django-tagging_
41
  * Pygments_
42
  * sorl-thumbnail_
43
  * south_
Jasper St. Pierre's avatar
Jasper St. Pierre committed
44

45 46
I develop with PostgreSQL_ at home, but Django should be able to use SQLite_,
MySQL_, and others. South_ is used for migrations.
Jasper St. Pierre's avatar
Jasper St. Pierre committed
47 48 49 50 51

.. _django: http://www.djangoproject.com/
.. _django-autoslug: http://packages.python.org/django-autoslug/
.. _django-extensions: http://packages.python.org/django-extensions/
.. _django-tagging: http://code.google.com/p/django-tagging/
52
.. _Pygments: http://www.pygments.org/
53
.. _sorl-thumbnail: http://thumbnail.sorl.net/
Jasper St. Pierre's avatar
Jasper St. Pierre committed
54 55 56
.. _PostgreSQL: http://www.postgresql.org/
.. _SQLite: http://www.sqlite.org/
.. _MySQL: http://www.mysql.com/
57
.. _south: http://south.aeracode.org/