Project Structure
authorChristophe de Vienne <christophe@unlish.com>
Wed, 02 Jul 2014 19:07:39 +0200
changeset 11479 a070f211b35c
child 11480 79ac26923432
Project Structure Related to #4291173
.hgignore
README.md
setup.py
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/.hgignore	Wed Jul 02 19:07:39 2014 +0200
@@ -0,0 +1,6 @@
+syntax: glob
+
+*.pyc
+*.swp
+
+*.egg-info
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.md	Wed Jul 02 19:07:39 2014 +0200
@@ -0,0 +1,26 @@
+[pyramid_cubicweb][] is one specific way of integrating [CubicWeb][] with a
+[Pyramid][] web application.
+
+### Features
+
+* provides a default route that let a cubicweb instance handle the request.
+
+### Usage
+
+To use, install pyramid_cubicweb in your python environment, 
+and then [include][] the package:
+
+    config.include('pyramid_cubicweb')
+
+### Configuration
+
+Requires the following [INI setting / environment variable][]:
+
+* `cubicweb.instance` / `CUBICWEB_INSTANCE`
+
+
+[pyramid_cubicweb]: https://www.cubicweb.org/project/pyramid-cubicweb
+[CubicWeb]: http://www.cubicweb.com/
+[Pyramid]: http://pypi.python.org/pypi/pyramid
+[include]: http://docs.pylonsproject.org/projects/pyramid/en/latest/api/config.html#pyramid.config.Configurator.include
+[INI setting / environment variable]: http://docs.pylonsproject.org/projects/pyramid/en/latest/narr/environment.html#adding-a-custom-setting
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/setup.py	Wed Jul 02 19:07:39 2014 +0200
@@ -0,0 +1,30 @@
+from setuptools import setup, find_packages
+
+
+setup(
+    name='pyramid_cubicweb',
+    version='0.1',
+    description='Integrate CubicWeb with a Pyramid application.',
+    author='Christophe de Vienne',
+    author_email='username: christophe, domain: unlish.com',
+    url='http://bitbucket.com/cdevienne/pyramid_cubicweb',
+    classifiers=[
+        'Development Status :: 3 - Alpha',
+        'Environment :: Web Environment',
+        'Intended Audience :: Developers',
+        'License :: Public Domain',
+        'Natural Language :: English',
+        'Operating System :: OS Independent',
+        'Programming Language :: Python',
+        'Programming Language :: Python :: 2.7',
+        'Programming Language :: Python :: 3',
+        'Framework :: Pylons',
+        'Topic :: Internet :: WWW/HTTP',
+        'Topic :: Internet :: WWW/HTTP :: WSGI',
+        'Topic :: Software Development :: Libraries :: Python Modules',
+    ],
+    packages=find_packages(),
+    include_package_data=True,
+    zip_safe=False,
+    install_requires=[]
+)