Permalink
Browse files

add example direcotry

  • Loading branch information...
0 parents commit 4c8bb78896168219451a27f2dfcf5eeb5e8cd30f @asaglimbeni committed Feb 28, 2013
@@ -0,0 +1,23 @@
+Copyright (c) 2013, Alfredo Saglimbeni (alfredo.saglimbeni(at)gmail.com)
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+* Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+* Redistributions in binary form must reproduce the above copyright
+notice, this list of conditions and the following disclaimer in the
+documentation and/or other materials provided with the distribution.
+* the names of its contributors may be used to endorse or promote products
+derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
@@ -0,0 +1,6 @@
+include LICENSE.txt
+include README.rst
+include MANIFEST.in
+recursive-include cicu *.py *.txt *.rst *.js *.css
+recursive-include cicu/static *.py *.txt *.js *.css
+recursive-include cicu/migrations *.py *.txt *.js *.css
@@ -0,0 +1,96 @@
+clean-image-crop-uploader (CICU)
+================================
+
+``clean-image-crop-uploader`` is a django widget to upload an image via Ajax and crop it using `Jcrop
+<https://github.com/tapmodo/Jcrop>`_. It provides a simple workflow: first one, using modal,
+(by `twitter bootstrap <http://twitter.github.com/bootstrap/javascript.html#modals>`_) the image can be uploaded and croped.
+Second one, you can see the image cropping preview in the form and finally submit the result.
+
+``clean-image-crop-uploader`` is perfect when you use an ImageField on your model where is necessary to have a specific . It's easy to configure and to use.
+You can use different configurations , with fixed aspect ratio or minimal image size.
+
+It works with jQuery = 1.8.3 and twitter bootstrap.
+
+Screenshot:
+
+#. Modal window with upload button:
+.. image:: http://
+
+#. Modal window with crop area:
+.. image:: http://
+
+#. Form with preview
+
+.. image:: http://
+
+Installation
+------------
+
+#. Install django-image-cropping using pip. For example::
+
+ pip install clean-image-crop-uploader
+
+#. Add ``south`` and ``cicu`` to your INSTALLED_APPS.
+
+#. run migrate commando to your django project::
+
+
+ python manage.py migrate
+
+Dependencies
+------------
+* jQuery = 1.8.3
+* Twitter-Bootstrap
+
+Configuration
+-------------
+
+#. Create your model-form and set CicuUploaderInput widget to your imageField ::
+
+ from cicu.widgets import CicuUploderInput
+
+ class yourCrop(forms.ModelForm):
+ class Meta:
+ model = yourModel
+ cicuOptions = {
+ 'ratioWidth': '600', #fix-width ratio, default 0
+ 'ratioHeight':'400', #fix-height ratio , default 0
+ 'sizeWarning': 'False', #if True the crop selection have to respect minimal ratio size defined above. Default 'False'
+ }
+ widgets = {
+ 'image': CicuUploderInput(options=cicuOptions)
+ }
+
+#. Download `twitter bootstrap <http://twitter.github.com/bootstrap/>`_ to your static file folder.
+
+#. Add in your form template links to jquery, bootstrap, form.media::
+
+ <head>
+ ....
+ <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.8.3/jquery.min.js"></script>
+ <link href="{{ STATIC_URL }}css/bootstrap.css" rel="stylesheet" type="text/css"/>
+ <script src="{{ STATIC_URL }}js/bootstrap.js"></script>
+ {{ form.media }}
+
+ ....
+ </head>
+
+
+Run the example
+---------------
+
+To run the example inside this package follow these commands::
+
+ > cd ./example/
+ > python manage.py syncdb
+ > python manage.py migrate # only if you use South!!!
+ > python manage.py runserver domain:8000
+
+Go to examples :
+#. Free crop : <http://domain:8000/cicu-freecrop/>
+#. Fixed aspect ratio: <http://domain:8000/cicu-fixedratio/>
+#. Fixed aspect ratio with minimal size: <http://domain:8000/cicu-warningsize/>
+
+
+
+
No changes.
@@ -0,0 +1,167 @@
+# Django settings for example project.
+import os
+DEBUG = False
+TEMPLATE_DEBUG = DEBUG
+
+ADMINS = (
+ # ('Your Name', 'your_email@example.com'),
+)
+
+PROJECT_ROOT = os.path.dirname(os.path.abspath(__file__))
+
+
+MANAGERS = ADMINS
+
+DATABASES = {
+ 'default': {
+ 'ENGINE': 'django.db.backends.sqlite3', # Add 'postgresql_psycopg2', 'mysql', 'sqlite3' or 'oracle'.
+ 'NAME': 'test.dev', # Or path to database file if using sqlite3.
+ 'USER': '', # Not used with sqlite3.
+ 'PASSWORD': '', # Not used with sqlite3.
+ 'HOST': '', # Set to empty string for localhost. Not used with sqlite3.
+ 'PORT': '', # Set to empty string for default. Not used with sqlite3.
+ }
+}
+
+# Local time zone for this installation. Choices can be found here:
+# http://en.wikipedia.org/wiki/List_of_tz_zones_by_name
+# although not all choices may be available on all operating systems.
+# In a Windows environment this must be set to your system time zone.
+TIME_ZONE = 'America/Chicago'
+
+# Language code for this installation. All choices can be found here:
+# http://www.i18nguy.com/unicode/language-identifiers.html
+LANGUAGE_CODE = 'en-us'
+
+SITE_ID = 1
+
+# If you set this to False, Django will make some optimizations so as not
+# to load the internationalization machinery.
+USE_I18N = True
+
+# If you set this to False, Django will not format dates, numbers and
+# calendars according to the current locale.
+USE_L10N = True
+
+# If you set this to False, Django will not use timezone-aware datetimes.
+USE_TZ = True
+
+# Absolute filesystem path to the directory that will hold user-uploaded files.
+# Example: "/home/media/media.lawrence.com/media/"
+MEDIA_ROOT = os.path.join(PROJECT_ROOT, "static/media/")
+
+# URL that handles the media served from MEDIA_ROOT. Make sure to use a
+# trailing slash.
+# Examples: "http://media.lawrence.com/media/", "http://example.com/media/"
+MEDIA_URL = '/static/media/'
+
+# Absolute path to the directory static files should be collected to.
+# Don't put anything in this directory yourself; store your static files
+# in apps' "static/" subdirectories and in STATICFILES_DIRS.
+# Example: "/home/media/media.lawrence.com/static/"
+STATIC_ROOT = os.path.join(PROJECT_ROOT, 'static/')
+
+# URL prefix for static files.
+# Example: "http://media.lawrence.com/static/"
+STATIC_URL = '/static/'
+
+# Additional locations of static files
+STATICFILES_DIRS = (
+ # Put strings here, like "/home/html/static" or "C:/www/django/static".
+ # Always use forward slashes, even on Windows.
+ # Don't forget to use absolute paths, not relative paths.
+)
+
+# List of finder classes that know how to find static files in
+# various locations.
+STATICFILES_FINDERS = (
+ 'django.contrib.staticfiles.finders.FileSystemFinder',
+ 'django.contrib.staticfiles.finders.AppDirectoriesFinder',
+# 'django.contrib.staticfiles.finders.DefaultStorageFinder',
+)
+
+TEMPLATE_CONTEXT_PROCESSORS = (
+ 'django.core.context_processors.static',
+)
+
+# Make this unique, and don't share it with anybody.
+SECRET_KEY = '@b&amp;mx=93o8w-+se%(79x^_7-#@whz#qsapo7_!y4^2ki-wjey6'
+
+# List of callables that know how to import templates from various sources.
+TEMPLATE_LOADERS = (
+ 'django.template.loaders.filesystem.Loader',
+ 'django.template.loaders.app_directories.Loader',
+# 'django.template.loaders.eggs.Loader',
+)
+
+MIDDLEWARE_CLASSES = (
+ 'django.middleware.common.CommonMiddleware',
+ 'django.contrib.sessions.middleware.SessionMiddleware',
+ 'django.middleware.csrf.CsrfViewMiddleware',
+ 'django.contrib.auth.middleware.AuthenticationMiddleware',
+ 'django.contrib.messages.middleware.MessageMiddleware',
+ # Uncomment the next line for simple clickjacking protection:
+ # 'django.middleware.clickjacking.XFrameOptionsMiddleware',
+)
+
+ROOT_URLCONF = 'example.urls'
+
+# Python dotted path to the WSGI application used by Django's runserver.
+WSGI_APPLICATION = 'example.wsgi.application'
+
+TEMPLATE_DIRS = ('/Users/LittleRepirro/PycharmProjects/example/templates',)
+
+INSTALLED_APPS = (
+ 'django.contrib.auth',
+ 'django.contrib.contenttypes',
+ 'django.contrib.sessions',
+ 'django.contrib.sites',
+ 'django.contrib.messages',
+ 'django.contrib.staticfiles',
+ # Uncomment the next line to enable the admin:
+ # 'django.contrib.admin',
+ # Uncomment the next line to enable admin documentation:
+ # 'django.contrib.admindocs',
+ 'cicu',
+ 'formexample',
+)
+
+TEMPLATE_CONTEXT_PROCESSORS = (
+ "django.contrib.auth.context_processors.auth",
+ "django.contrib.messages.context_processors.messages",
+ "django.core.context_processors.debug",
+ "django.core.context_processors.i18n",
+ "django.core.context_processors.static",
+ "django.core.context_processors.media",
+ "django.core.context_processors.request",
+ "django.core.context_processors.tz",
+ )
+
+# A sample logging configuration. The only tangible logging
+# performed by this configuration is to send an email to
+# the site admins on every HTTP 500 error when DEBUG=False.
+# See http://docs.djangoproject.com/en/dev/topics/logging for
+# more details on how to customize your logging configuration.
+LOGGING = {
+ 'version': 1,
+ 'disable_existing_loggers': False,
+ 'filters': {
+ 'require_debug_false': {
+ '()': 'django.utils.log.RequireDebugFalse'
+ }
+ },
+ 'handlers': {
+ 'mail_admins': {
+ 'level': 'ERROR',
+ 'filters': ['require_debug_false'],
+ 'class': 'django.utils.log.AdminEmailHandler'
+ }
+ },
+ 'loggers': {
+ 'django.request': {
+ 'handlers': ['mail_admins'],
+ 'level': 'ERROR',
+ 'propagate': True,
+ },
+ }
+}
@@ -0,0 +1,25 @@
+from django.conf.urls import patterns, include, url
+from django.conf import settings
+
+# Uncomment the next two lines to enable the admin:
+# from django.contrib import admin
+# admin.autodiscover()
+
+urlpatterns = patterns('',
+ (r'^static/media/(?P<path>.*)$', 'django.views.static.serve', {
+ 'document_root': settings.MEDIA_ROOT}),
+ (r'^static/(?P<path>.*)$', 'django.views.static.serve', {
+ 'document_root': settings.STATIC_ROOT}),
+ (r'^ajax-upload/', include('cicu.urls')),
+ ("^", include("formexample.urls")),
+
+ # Examples:
+ # url(r'^$', 'example.views.home', name='home'),
+ # url(r'^example/', include('example.foo.urls')),
+
+ # Uncomment the admin/doc line below to enable admin documentation:
+ # url(r'^admin/doc/', include('django.contrib.admindocs.urls')),
+
+ # Uncomment the next line to enable the admin:
+ # url(r'^admin/', include(admin.site.urls)),
+)
@@ -0,0 +1,28 @@
+"""
+WSGI config for example project.
+
+This module contains the WSGI application used by Django's development server
+and any production WSGI deployments. It should expose a module-level variable
+named ``application``. Django's ``runserver`` and ``runfcgi`` commands discover
+this application via the ``WSGI_APPLICATION`` setting.
+
+Usually you will have the standard Django WSGI application here, but it also
+might make sense to replace the whole Django WSGI application with a custom one
+that later delegates to the Django one. For example, you could introduce WSGI
+middleware here, or combine a Django application with an application of another
+framework.
+
+"""
+import os
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "example.settings")
+
+# This application object is used by any WSGI server configured to use this
+# file. This includes Django's development server, if the WSGI_APPLICATION
+# setting points here.
+from django.core.wsgi import get_wsgi_application
+application = get_wsgi_application()
+
+# Apply WSGI middleware here.
+# from helloworld.wsgi import HelloWorldApplication
+# application = HelloWorldApplication(application)
No changes.
Oops, something went wrong.

0 comments on commit 4c8bb78

Please sign in to comment.