[Checkins] SVN: hurry.resource/trunk/ Preparing for initial release.
Martijn Faassen
faassen at infrae.com
Tue Oct 7 11:39:24 EDT 2008
Log message for revision 91856:
Preparing for initial release.
Changed:
A hurry.resource/trunk/CHANGES.txt
U hurry.resource/trunk/setup.py
U hurry.resource/trunk/src/hurry/resource/README.txt
-=-
Added: hurry.resource/trunk/CHANGES.txt
===================================================================
--- hurry.resource/trunk/CHANGES.txt (rev 0)
+++ hurry.resource/trunk/CHANGES.txt 2008-10-07 15:39:24 UTC (rev 91856)
@@ -0,0 +1,7 @@
+CHANGES
+*******
+
+0.1 (2008-10-07)
+================
+
+* Initial public release.
Modified: hurry.resource/trunk/setup.py
===================================================================
--- hurry.resource/trunk/setup.py 2008-10-07 15:32:22 UTC (rev 91855)
+++ hurry.resource/trunk/setup.py 2008-10-07 15:39:24 UTC (rev 91856)
@@ -1,15 +1,28 @@
from setuptools import setup, find_packages
import sys, os
+def read(*rnames):
+ return open(os.path.join(os.path.dirname(__file__), *rnames)).read()
+
+long_description = (
+ read('src', 'hurry', 'resource', 'README.txt')
+ + '\n' +
+ read('CHANGES.txt')
+ + '\n' +
+ 'Download\n'
+ '********\n'
+ )
+
setup(
name='hurry.resource',
version='0.1dev',
description="Flexible resources.",
+ long_description=long_description,
classifiers=[],
keywords='',
author='Martijn Faassen',
author_email='faassen at startifact.com',
- license='',
+ license='ZPL 2.1',
packages=find_packages('src'),
package_dir={'': 'src'},
include_package_data=True,
Modified: hurry.resource/trunk/src/hurry/resource/README.txt
===================================================================
--- hurry.resource/trunk/src/hurry/resource/README.txt 2008-10-07 15:32:22 UTC (rev 91855)
+++ hurry.resource/trunk/src/hurry/resource/README.txt 2008-10-07 15:39:24 UTC (rev 91856)
@@ -1,8 +1,8 @@
hurry.resource
-==============
+**************
Introduction
-------------
+============
Resources are files that are used as resources in the display of a web
page, such as CSS files, Javascript files and images. Resources
@@ -28,7 +28,7 @@
libraries, inclusion and inclusion requirements.
A resource library
-------------------
+==================
We define a library ``foo``::
@@ -36,7 +36,7 @@
>>> foo = Library('foo')
Inclusion
----------
+=========
We now create an inclusion of a particular resource in a library. This
inclusion needs ``a.js`` from ``library`` and ``b.js`` as well::
@@ -50,7 +50,7 @@
>>> y1 = ResourceInclusion(foo, 'c.js', depends=[x1, x2])
Inclusion requirements
-----------------------
+======================
When rendering a web page we want to require the inclusion of a
resource anywhere within the request handling process. We might for
@@ -78,7 +78,7 @@
As you can see, ``css`` resources are sorted before ``js`` resources.
A convenience spelling
-----------------------
+======================
When specifying that we want a resource inclusion to be rendered, we
now need access to the current ``NeededInclusions`` object and the
@@ -170,7 +170,7 @@
easier to read for the purposes of this document.
Multiple requirements
----------------------
+=====================
In this section, we will show what happens in various scenarios where
we requiring multiple ``ResourceInclusion`` objects.
@@ -284,7 +284,7 @@
<ResourceInclusion 'a5.js' in library 'foo'>]
Modes
------
+=====
A resource can optionally exist in several modes, such as for instance
a minified and a debug version. Let's define a resource that exists in
@@ -331,7 +331,7 @@
they functionally should do the same.
"Rollups"
----------
+=========
For performance reasons it's often useful to consolidate multiple
resources into a single, larger resource, a so-called
@@ -524,10 +524,8 @@
[<ResourceInclusion 'h1-debug.js' in library 'foo'>,
<ResourceInclusion 'h2-debug.js' in library 'foo'>]
-XXX superseding along with dependencies...
-
Rendering resources
--------------------
+===================
Let's define some needed resource inclusions::
@@ -573,7 +571,7 @@
<script type="text/javascript" src="http://localhost/static/foo/c.js"></script>
Generating resource code
-------------------------
+========================
Sometimes it is useful to generate code that expresses a complex
resource dependency structure. One example of that is in
@@ -633,7 +631,7 @@
i2 = ResourceInclusion(foo, 'i2.js', depends=[hoi])
Sorting inclusions by dependency
---------------------------------
+================================
This is more a footnote than something that you should be concerned
about. In case assumptions in this library are wrong or there are
More information about the Checkins
mailing list