Commits

wlansu committed f263898

messing with mercurial

  • Participants
  • Parent commits 96a507b

Comments (0)

Files changed (14)

+recursive-include cookie_law/templates *
+Django cookie law
+=================
+This is a Django application that makes it easy to implement cookies compliant with Dutch law, as far as I am able
+to tell. I'm not a lawyer, so use at your own risk.
+
+Updating
+========
+
+From 0.1.6 to 0.2 or higher
+-------------------
+
+The model has changed, run South migrations. Multilingual support has been added. Optional title and close fields
+added.
+
+
+From 0.1.4 to 0.1.5
+--------------------
+
+If you're updating from 0.1.4 to 0.1.5 take note that the CookieBar model has changed,
+you should run the South migrations.
+
+
+Requirements
+============
+
+- jQuery>=1.5.1
+
+Usage
+=====
+
+- Add the cookie_law app to your INSTALLED_APPS.
+- Add 'url(r'^cookies/', include('cookie_law.urls')),' to your main urls.py, without the ''.
+- Run the cookie_law migrations or syncdb if you don't use South, but you should.
+- Load the cookie_bar template tags and include {% show_cookie_bar %} under the <body> tag in your base template.
+- Create a cookie bar in the admin (if you do not a default bar will be created, you should edit this asap).
+- Surround your cookies with {% if request.COOKIES.allow_cookies == '1' %} <cookie> {% endif %}
+- To change the domain used for the cookies to check a visitor's preferences, create a Django setting.COOKIE_LAW_DOMAIN
+
+
+Cookie Bar Details
+------------------
+
+- Optional title:
+    This title can be displayed as a title for your text
+- Optional link cookie policy page:
+    If you want a page explaining what kind of cookies you use and why place the full url here.
+- Optional display name of the link:
+    This will be displayed after the display text. For instance:
+    "This site uses cookies, read about it <link_display_name>"
+- Title of the allow cookie button:
+    This will be the text shown in the cookie bar button.
+- Text:
+    The text displayed in the cookie bar.
+- "This cookie bar is displayed":
+    Check this if you want this particular cookie bar to be shown.
+    Cookie bars without this boolean will not be shown.
+- Optional "Show a close (dismiss) button for this cookie bar" boolean:
+    The close field is used when you want to give visitors the option to hide the cookie bar
+    while not accepting cookies. This is turned off by default.
+- Optional Language:
+    You can create a cookie bar for multiple languages, read more about this in the Multilingual support section.
+    Each of these cookie bars will need the "This cookie bar is displayed" boolean set to True.
+
+
+Multilingual Support
+--------------------
+
+If you want multilingual support add the languages you want to your settings file.
+LANGUAGES = (('nl','Nederlands'), ('en','English'))
+Every time the cookie bar template tag is called it will check if a cookie bar exists for each language,
+if not; one will be created. It is up to you to translate these into the right language.
+You can do this via the admin.
+
+The multilingual support works by checking for a LANGUAGE_CODE in the request.
+Localization middleware should handle this. If this doesn't exist the default Dutch cookie bar will be used.
+import os
+
+from setuptools import setup
+
+install_requires = []
+
+README_PATH = os.path.join(os.path.abspath(os.path.dirname(__file__)), 'README')
+
+description = 'Django specific cookie implementation compliant with Dutch law, use at your own risk.'
+
+if os.path.exists(README_PATH):
+    long_description = open(README_PATH).read()
+else:
+    long_description = description
+
+packages, data_files = [], []
+root_dir = os.path.dirname(__file__)
+if root_dir:
+    os.chdir(root_dir)
+
+for dirpath, dirnames, filenames in os.walk('cookie_law'):
+    # Ignore dirnames that start with '.'
+    for i, dirname in enumerate(dirnames):
+        if dirname.startswith('.'): del dirnames[i]
+    if '__init__.py' in filenames:
+        pkg = dirpath.replace(os.path.sep, '.')
+        if os.path.altsep:
+            pkg = pkg.replace(os.path.altsep, '.')
+        packages.append(pkg)
+    elif filenames:
+        prefix = dirpath[11:] # Strip "cookie_law/"
+        for f in filenames:
+            data_files.append(os.path.join(prefix, f))
+
+
+
+setup(
+    name='django-cookie-law-nl',
+    version='0.2.1',
+    install_requires=install_requires,
+    include_package_data=True,
+    description=description,
+    long_description=long_description,
+    author='Wouter Lansu',
+    author_email='wfrlansu@gmail.com',
+    url='https://bitbucket.org/wlansu/django_cookie_law_nl',
+    packages=packages,
+    classifiers=[
+        "Development Status :: 4 - Beta",
+        "License :: OSI Approved :: BSD License",
+        "Programming Language :: Python",
+        "Framework :: Django",
+        "Topic :: Internet",
+        "Topic :: Software Development :: Libraries :: Python Modules",
+        "Intended Audience :: Developers",
+    ],
+)