Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

Package which provides API and scripts to manage a skin directory of a VUDO app.

Project Description

Introduction

This package provides an light-weight API for vudo packages which provide user-changeable skins. These packages may advertise their skin directory using setuptools entry points.

Additionally, this package provides a script to manage the skin directory of a vudo project in a convenient way.

Usage

Developers, which want to make vudo packages which provide skins, need to include their skin resources in the EGG, and include a entry point.

Skin Resources

Depending whether or not a SCM system supported by setuptools (currently SVN) is used or not, developers may need to include their resources manually using package_data:

setup(name='vudo.compositepage',
      ...
      packages=find_packages('src'),
      package_dir = {'': 'src'},
      package_data = {
          "vudo.compositepage": [
              "skin/*.zcml",
              "skin/compositepage/*.zcml",
              "skin/compositepage/ajax/*.pt",
              "skin/region/*.pt",
              ]
          },
      ...
      )

Entry Point

Additionally to include the skin resources in the package egg, the skin needs to be advertized using a entry point:

setup(name='vudo.compositepage',
      ...
      entry_points="""
      # -*- Entry points: -*-
      [vudo.skin]
      compositepage=vudo.compositepage:provide_skin [skin]
      """,
      extras_require={
          "skin": "vudo.skinsetup",
      },
      ...
  )

The provide_skin mentioned above needs to call the vudo.skinsetup package API to return the skin information:

def provide_skin():
    import os
    from vudo.skinsetup import provide_skin
    return provide_skin(
            package="vudo.compositepage",
            name="compositepage",
            skin_path="skin")

the parameters to the provide_skin method are as follows:

package
The package name which provides the skin
name
The skin name
skin_path
The path to the skin within the package. Note, this is usually a setuptools resource path, and thus always “/” separated. Do not use os.path.

Change history

Changelog

0.1 (2008-12-08)

  • Script entry point for vudoskin script. [seletz]
  • Very basic API for vudo packages which want to provide a skin [seletz]
  • Initial package setup. [seletz]

Contributors

Stefan Eletzhofer, Author

Download

Release History

Release History

This version
History Node

0.1

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
vudo.skinsetup-0.1.zip (12.6 kB) Copy SHA256 Checksum SHA256 Source Dec 8, 2008

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting