https://github.com/philipsahli/xcore

Python and Django helper modules
https://github.com/philipsahli/xcore

Last synced: 10 days ago
JSON representation

Python and Django helper modules

• Host: GitHub
• URL: https://github.com/philipsahli/xcore
• Owner: philipsahli
• Created: 2011-03-28T06:28:56.000Z (almost 14 years ago)
• Default Branch: master
• Last Pushed: 2012-06-18T03:42:50.000Z (over 12 years ago)
• Last Synced: 2024-11-12T01:18:24.657Z (2 months ago)
• Language: Python
• Homepage: http://sahli.net/projects/xcore
• Size: 3.87 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst

Awesome Lists containing this project

README

        
=============

What is Xcore

=============

Xcore is a collection of helper apps, middlewares and more for Django.

.. contents::

============

Installation

============

::

 pip install django_xcore

Label App

=========

Create titles on your website as images in png-format with shipped or your own fonts.

Features:

 * label get cached when template gets rendered, if caching is enabled (strongly recommended)

 * supports HTTP 302 with etag and last-modified HTTPHeaders

Included fonts:

* Some fonts are included, taken from:

 * http://www.dafont.com

 * http://openfontlibrary.org/

 * License included if provided by the creator.

Usage::

 {% load label_tags %}

 ...

 
{{ 'My Title'|labelize:"class=default" }}

 
{{ 'My Title'|labelize:"color=#DF1F72&font=Futura Md BT Bold" }}


Configuration

-------------

Place your fontfiles (ttf or otf format) in XCORE_FONTS_DIR:

settings.py::

 XCORE_FONTS_DIR = [os.path.join(projectdir, "fonts_dir")]

Configure a class with font name (as defined in fontfile), size and color:

::

 XCORE_LABELCONFIG = {

    'default': {

        'font': "Caviar Dreams Bold",

         'size': "22",

         'color': "#DF1F72",

    }

 }

Management command

------------------

 ::

 python manage.py list_fonts

Output of all font-files which are recognized.

Middlewares

===========

EmailOnNotFoundMiddleware

-------------------------

 xcore.forwarded.middleware.ForwardedMiddleware

Sends an email to the admin if a HttpResponseNotFound happens (if settings.DEBUG is false).

ForwardedMiddleware

-------------------

 xcore.forwarded.middleware.ForwardedMiddleware

If a django webapp must be reached only proxied by another server, you can activate this middleware.

Configuration:

* settings.ONLY_FORWARDED (true or false)

* settings.HOST_FORWARDED (Host which must be in HTTP_X_FORWARDED_HOST Header-Field)

* settings.REDIRECT_FORWARDED (URL to redirect to in HttpRedirectResponse)

MaintenanceMiddleware

---------------------

 xcore.maintenance.middleware.MaintenanceMiddleware

If settings.MAINTENANCE_ON is True, a HttpResponseServiceUnavailable (Response-Code 503) is returned.

The paths for admin and __debug__ are excluded for this functionality, therefore in maintenance mode the admin

can still login into Django Admin and the HTML-File which can be displayed is available under the

URL '/media/maintenance/index.html'

In Mezzanine the setting is registered as editable setting in the admin.

Profiling

=========

 xcore.profiler

Decorate a python function as follows:

 @profile("/tmp/profiling/")

Execute your program and be sure the function gets executed sometimes.

Then you can view the results:

 python manage.py profile_result