Skip to content
Switch branches/tags
Go to file
Cannot retrieve contributors at this time

Integrate sketchbook into your projects

Simple integration:

from sketchbook import Sketch

import asyncio

async def draw_sketch(name: str) -> str:
    return await Sketch("Hello, <%= name %>.").draw(name=name)

loop = asyncio.get_event_loop()

assert loop.run_until_complete(draw_sketch("John Smith")) == "Hello, John Smith."

This is suitable for most simple use cases, but you cannot modify behaviours of sketches. Also, it cannot include or inherit from other templates.

Modify Default Behaviours

To modify the default behaviours of :class:`.Sketch`, you need to create a :class:`.AsyncioSketchContext` or :class:`CurioSketchContext`. For example, if you want to use a custom event loop for sketchbook:

from sketchbook import Sketch, AsyncioSketchContext

import uvloop

loop = uvloop.Loop()
# This is not the recommended way to use uvloop,
# please refer to their documentation to set the event loop policy.

skt_ctx = AsyncioSketchContent(loop=loop)

async def draw_sketch(name: str) -> str:
    return await Sketch("Hello, <%= name %>.", skt_ctx=skt_ctx).draw(name=name)

assert loop.run_until_complete(draw_sketch("John Smith")) == "Hello, John Smith."

Inheritance and Inclusion

To enable inclusion and inheritance, you need a sketch finder to help sketches find other sketches. You can use finders provided by sketchbook or write your own from :class:`.BaseSketchFinder`.

Let's say that you have a directory called sketches and a program with the following layout:


In the files above, home.html inherits from layout.html, and layout.html includes header.html and footer.html. Your program is under the main directory(/).

Then, to use sketches in directory sketches, put the following code in

from sketchbook import SyncSketchFinder

import asyncio

skt_finder = SyncSketchFinder("sketches")

async def draw_sketch() -> str:
    home_skt = await skt_finder.find("home.html")

    return await home_skt.draw()

loop = asyncio.get_event_loop()


Sketch contexts also works in :class:`.BaseSketchFinder`:

from sketchbook import AsyncSketchFinder, AsyncioSketchContext

skt_ctx = AsyncioSketchContext(cache_sketches=False)
# You can disable sketch cache in development.

skt_finder = AsyncSketchFinder("sketches", skt_ctx=skt_ctx)

Use concurrent I/O as the asynchronous library

If you want to use concurrent I/O as the asynchronous library in your project, you need to create your sketches or finders with :class:`.CurioSketchContext` or it will still use asyncio internally.

from sketchbook import CurioSketchContext, Sketch

import curio

sketch = Sketch("Hello, <%= await name %>!", skt_ctx=CurioSketchContext())

assert"John Smith")) == "Hello, John Smith!"