tweaking scaffold and docs

Author: jstoiko

docs/source/changelog.rst

@@ -2,8 +2,8 @@ Changelog
 =========
 
 * :release:`0.3.1 <2015-07-06>`
-* :support:`- backported` Added support for callables in "default" field argument
-* :support:`- backported` Added support for "onupdate" field argument
+* :support:`- backported` Added support for callables in 'default' field argument
+* :support:`- backported` Added support for 'onupdate' field argument
 
 * :release:`0.3.0 <2015-06-14>`
 * :support:`-` Added python3 support
@@ -21,7 +21,7 @@ Changelog
 * :bug:`-` Fixed custom processors
 
 * :release:`0.2.0 <2015-05-18>`
-* :feature:`-` Added support for securitySchemes, authentication (Pyramid "auth ticket") and ACLs
+* :feature:`-` Added support for securitySchemes, authentication (Pyramid 'auth ticket') and ACLs
 * :support:`-` Added several display options to schemas
 * :support:`-` Added unit tests
 * :support:`-` Improved docs

docs/source/fields.rst

@@ -26,6 +26,7 @@ Available Types
 * list
 * dict
 
+
 Required Fields
 ---------------
 
@@ -38,6 +39,7 @@ You can set a field as required by setting the ``required`` property.
         (...)
     }
 
+
 Primary Key
 -----------
 
@@ -52,6 +54,7 @@ You can set a field as the primary key by setting the ``primary_key`` property u
         }
     }
 
+
 Constraints
 -----------
 
@@ -68,28 +71,24 @@ You can set a minimum and/or maximum length of your field by setting the ``min_l
         }
     }
 
-Custom Field Processors
------------------------
 
-You can set custom field processors by referencing the names of such processors in the ``processors`` property under ``args``.
+Field Processors
+----------------
+
+You can define field processors by referencing their names in the ``before_validation`` and ``after_validation`` properties under ``args``. `before_` and `after_` prefixes refer when those processors are executed, either before or after database validation.
 
 .. code-block:: json
 
     "field": {
         (...)
         "args": {
-            "processors": ["custom_processor"]
+            "before_validation": ["custom_processor"],
+            "after_validation": ["other_custom_processor"]
         }
     }
 
-You can then define each custom processor in a function in your ``__init__.py`` file.
+You can read more about field processors :doc:`here <processors>`.
 
-.. code-block:: python
-
-    @registry.add
-    def custom_processor(value):
-        """ This is a field processor """
-        return (value or '').lower().strip()
 
 Relationship Fields
 -------------------
@@ -107,6 +106,7 @@ For relationship fields, you can define the name of your 'relation' model by set
         }
     }
 
+
 Default Value
 -------------
 
@@ -132,6 +132,7 @@ The ``default`` value can also be set to a Python callable, e.g.
         }
     },
 
+
 Update Default Value
 --------------------
 
@@ -146,6 +147,7 @@ You can set an update default value for your field by setting the ``onupdate`` p
         }
     },
 
+
 List Fields
 -----------
 

docs/source/index.rst

@@ -1,9 +1,9 @@
 Ramses
 ======
 
-Github: `<http://github.com/brandicted/ramses>`_
+Source code: `<http://github.com/brandicted/ramses>`_
 
-Ramses is a library that generates a RESTful API using RAML. It uses Pyramid and `Nefertari <https://nefertari.readthedocs.org/>`_ which provides ElasticSearch-powered views.
+Ramses is a library that generates a RESTful API using RAML. It uses Pyramid and `Nefertari <https://nefertari.readthedocs.org/>`_ which provides `ElasticSearch-powered requests <http://nefertari.readthedocs.org/en/stable/making_requests.html>`_.
 
 Table of Contents
 =================
@@ -15,6 +15,7 @@ Table of Contents
    raml
    schemas
    fields
+   processors
    changelog
 
 .. image:: ramses.jpg

docs/source/processors.rst

@@ -0,0 +1,19 @@
+Field Processors
+================
+
+Writing Processors
+------------------
+
+You can then define each custom processor in a function in your ``__init__.py`` file. A processor receives two arguments: `instance`, the object's instance, and `new_value`, the new value being set.
+
+.. code-block:: python
+
+    @registry.add
+    def custom_processor(instance, new_value):
+        """ This is a field processor """
+        return (new_value or '').lower().strip()
+
+
+Accessing Other Models
+----------------------
+

ramses/scaffolds/ramses_starter/README.md

@@ -1,6 +1,7 @@
 ## Installation
 ```
 $ pip install -r requirements.txt
+```
 
 ## Run
 ```

ramses/scaffolds/ramses_starter/local.ini_tmpl

@@ -1,14 +1,15 @@
 [app:{{package}}]
 use = egg:{{package}}
+
+# Ramses
 ramses.raml_schema = api.raml
+ramses.auth = false
 
+# Nefertari
 nefertari.engine = nefertari_{{engine}}
-
-ramses.auth = false
 auth_tkt_secret = {{random_string}}
 debug = true
 public_max_limit = 100
-
 system.user = system
 system.password = 123456
 system.email = user@domain.com
@@ -27,18 +28,18 @@ elasticsearch.sniff = false
 elasticsearch.index_name = {{package}}
 elasticsearch.index.disable = false
 elasticsearch.enable_refresh_query = false
+elasticsearch.enable_aggregations = false
+elasticsearch.enable_polymorphic_query = false
 
 # {{package}}
 host = localhost
-base_url = http://%(host)s
+base_url = http://%(host)s:6543
 
 # CORS
 cors.enable = false
 cors.allow_origins = %(base_url)s
 cors.allow_credentials = true
 
-request_timing.enable = true
-
 [composite:main]
 use = egg:Paste#urlmap
 /api/ = {{package}}
@@ -68,12 +69,12 @@ handlers =
 qualname = {{package}}
 
 [logger_nefertari]
-level = DEBUG
+level = INFO
 handlers =
 qualname = nefertari
 
 [logger_ramses]
-level = DEBUG
+level = INFO
 handlers =
 qualname = ramses
 

ramses/scaffolds/ramses_starter/requirements.txt

@@ -1,5 +1,6 @@
 nefertari
 ramses
+
 Paste==2.0.2
 pyramid==1.5.7
 waitress==0.8.9

ramses/scaffolds/ramses_starter/setup.py_tmpl

@@ -3,26 +3,27 @@ from setuptools import setup, find_packages
 requires = ['pyramid']
 
 setup(name='{{package}}',
-      version='0.0.1',
-      description='',
-      long_description='',
-      classifiers=[
-          "Programming Language :: Python",
-          "Framework :: Pyramid",
-          "Topic :: Internet :: WWW/HTTP",
-          "Topic :: Internet :: WWW/HTTP :: WSGI :: Application",
-      ],
-      author='',
-      author_email='',
-      url='',
-      keywords='web pyramid pylons',
-      packages=find_packages(),
-      include_package_data=True,
-      zip_safe=False,
-      install_requires=requires,
-      tests_require=requires,
-      test_suite="{{package}}",
-      entry_points="""\
-      [paste.app_factory]
-          main = {{package}}:main
-      """)
+    version='0.0.1',
+    description='',
+    long_description='',
+    classifiers=[
+        "Programming Language :: Python",
+        "Framework :: Pyramid",
+        "Topic :: Internet :: WWW/HTTP",
+        "Topic :: Internet :: WWW/HTTP :: WSGI :: Application",
+    ],
+    author='',
+    author_email='',
+    url='',
+    keywords='web pyramid pylons raml ramses',
+    packages=find_packages(),
+    include_package_data=True,
+    zip_safe=False,
+    install_requires=requires,
+    tests_require=requires,
+    test_suite="{{package}}",
+    entry_points="""\
+    [paste.app_factory]
+        main = {{package}}:main
+    """,
+)

setup.py

@@ -32,7 +32,7 @@
       author='Brandicted',
       author_email='hello@brandicted.com',
       url='https://github.com/brandicted/ramses',
-      keywords='web pyramid pylons',
+      keywords='web pyramid pylons nefertari raml',
       packages=find_packages(),
       include_package_data=True,
       zip_safe=False,
@@ -41,5 +41,5 @@
       test_suite="ramses",
       entry_points="""\
         [pyramid.scaffold]
-        ramses_starter=ramses.scaffolds:RamsesStarterTemplate
+        ramses_starter = ramses.scaffolds:RamsesStarterTemplate
       """)