diff --git a/inkycal/custom/functions.py b/inkycal/custom/functions.py index cac626d..5c96c6d 100644 --- a/inkycal/custom/functions.py +++ b/inkycal/custom/functions.py @@ -46,12 +46,12 @@ def get_fonts(): Returns: printed output of all available fonts. To access a fontfile, use the fonts dictionary to access it. - + >>> fonts['fontname'] To use a font, use the following sytax, where fontname is one of the printed fonts of this function: - + >>> ImageFont.truetype(fonts['fontname'], size = 10) """ for fonts in available_fonts: @@ -61,7 +61,7 @@ def get_fonts(): def get_system_tz(): """Gets the system-timezone - Gets the timezone set by the system. + Gets the timezone set by the system. Returns: - A timezone if a system timezone was found. @@ -106,7 +106,7 @@ def auto_fontsize(font, max_height): def write(image, xy, box_size, text, font=None, **kwargs): - """Writes text on a image. + """Writes text on a image. Writes given text at given position on the specified image. @@ -185,8 +185,10 @@ def write(image, xy, box_size, text, font=None, **kwargs): draw = ImageDraw.Draw(image) space = Image.new('RGBA', (box_width, box_height)) ImageDraw.Draw(space).text((x, y), text, fill=colour, font=font) + # Uncomment following two lines, comment out above two lines to show # red text-box with white text (debugging purposes) + #space = Image.new('RGBA', (box_width, box_height), color= 'red') #ImageDraw.Draw(space).text((x, y), text, fill='white', font=font) @@ -258,7 +260,7 @@ def draw_border(image, xy, size, radius=5, thickness=1, shrinkage=(0.1,0.1)): Args: - image: The image on which the border should be drawn (usually im_black or im_colour. - + - xy: Tuple representing the top-left corner of the border e.g. (32, 100) where 32 is the x co-ordinate and 100 is the y-coordinate. diff --git a/inkycal/display/display.py b/inkycal/display/display.py index 8cd0a2e..e5b9ced 100644 --- a/inkycal/display/display.py +++ b/inkycal/display/display.py @@ -19,7 +19,7 @@ class Display: args: - epaper_model: The name of your E-Paper model. - + """ def __init__(self, epaper_model): @@ -58,14 +58,14 @@ class Display: black in this image will show up as either red/yellow. Rendering an image for black-white E-Paper displays: - + >>> sample_image = PIL.Image.open('path/to/file.png') >>> display = Display('my_black_white_display') >>> display.render(sample_image) Rendering black-white on coloured E-Paper displays: - + >>> sample_image = PIL.Image.open('path/to/file.png') >>> display = Display('my_coloured_display') >>> display.render(sample_image, sample_image) @@ -204,7 +204,7 @@ class Display: access to the E-Paper. You can use this function directly without creating the Display class: - + >>> Display.get_display_names() """ driver_files = top_level+'/inkycal/display/drivers/*.py' @@ -213,7 +213,7 @@ class Display: drivers.remove('__init__') drivers.remove('epdconfig') print(*drivers, sep='\n') - + if __name__ == '__main__': print("Running Display class in standalone mode") - +