{
"info": {
"author": "Cody Landry",
"author_email": "cody.landry@me.com",
"bugtrack_url": null,
"classifiers": [
"License :: OSI Approved :: MIT License",
"Programming Language :: Python",
"Programming Language :: Python :: 2.6",
"Programming Language :: Python :: 2.7",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.3",
"Programming Language :: Python :: 3.4",
"Programming Language :: Python :: 3.5",
"Programming Language :: Python :: 3.6",
"Programming Language :: Python :: Implementation :: CPython",
"Programming Language :: Python :: Implementation :: PyPy"
],
"description": "# Smores\n[]()\n[]()\n[]()\n[](https://coveralls.io/github/codylandry/Smores?branch=master)\n\nSmores allows you to specify a schema for user facing template features. It leverages marshmallow (hence 'smores') to\npopulate and transform data that is then rendered via jinja. It has a parser that presents a more friendly syntax to \nusers (ex. {user.addresses:1.street}). It also includes an autocomplete method that gives you intellisense style \noptions given a tag fragment. \n\nSmores provides two Marshmallow field types called TemplateString and TemplateFile. Templates defined in these fields\nare scoped to that schema and it's descendants. Each schema can have a _default_template that, if defined, will what\nis inserted if the associated tag ends with that schema. For example: typing {user.address} will render the _default_template\nfor the Address schema. You can define other template attributes as well. For example, see the 'google_link' attribute\nof the Address schema below. Typing {user.address.google_link} will populate and insert that link. \n\nsmores.tag_autocomplete is a method where you can provide a tag 'fragment' and it will return the possible options below that.\nFor example:\n\n```python\nfrom smores import Smores, TemplateString\nfrom marshmallow import Schema, fields\n\n# instantiate a smores instance\nsmores = Smores()\n\n# smores.schema registers the schema with the instance\n@smores.schema\nclass Coordinates(Schema):\n lat = fields.Decimal()\n lng = fields.Decimal()\n _default_template = TemplateString(\"{{lat}},{{lng}}\")\n\n@smores.schema\nclass Address(Schema):\n street = fields.String()\n suite = fields.String()\n city = fields.String()\n state = fields.String()\n zipcode = fields.String()\n coordinates = fields.Nested(Coordinates)\n google_link = TemplateString('View Map')\n _default_template = TemplateString(\"\"\"\n
\n \"\"\")\n\n@smores.schema\nclass User(Schema):\n id = fields.Integer()\n name = fields.String()\n email = fields.Email()\n address = fields.Nested(Address)\n _default_template = TemplateString(\"\"\"\n
{{name}}
\n
E: {{email}}
\n
{{address}}
\n \"\"\")\n``` \n\n\n```python\n# for the schemas above, simply invoke the autocomplete method with a tag fragment\n\n>>> smores.autocomplete(\"\")\nAutocompleteResponse(tagStatus='INVALID', options=['address', 'coordinates', 'user'])\n\n>>> smores.autocomplete('user')\nAutocompleteResponse(tagStatus='VALID', options=['_default_template', 'address', 'email', 'id', 'name'])\n\n>>> smores.autocomplete('us')\nAutocompleteResponse(tagStatus='INVALID', options=['user'])\n\n>>> smores.autocomplete(\"user.address.coordinates\")\nAutocompleteResponse(tagStatus='VALID', options=['_default_template', 'lat', 'lng'])\n\n# Receiving '_default_template' or no results means that the current tag fragment is valid but _default_template\n# shouldn't be appended to the tag in the ui.\n``` \n\n\n```python\n# provide data to the render function\ndata = {\n \"user\": {\n \"id\": 1,\n \"name\": \"Leanne Graham\",\n \"username\": \"Bret\",\n \"email\": \"Sincere@april.biz\",\n \"phone\": \"1-770-736-8031 x56442\",\n \"address\": {\n \"street\": \"Kulas Light\",\n \"suite\": \"Apt. 556\",\n \"city\": \"Gwenborough\",\n \"state\": \"MD\",\n \"zipcode\": \"92998-3874\",\n \"coordinates\": {\n \"lat\": \"36.065934\",\n\t\t\t\t\"lng\": \"-79.791414\"\n }\n },\n }\n}\n\n# provide user created template\nuser_template = \"\"\"\n
Hi, {user.name}!
\n
Your Info:
\n {user}\n\"\"\"\n\n# render the output\nprint smores.render(data, user_template)\n\n# output -->\n#