Usage¶

TODO: say that content.padding isn’t always took into consideration

This article is a tutorial for nider package and at the same time it is a full reference of all nider models and possibilities.

Image units¶

There are three main units each nider.Image can consist of:

header
paragraph
linkback

Paragraph unit is required for each image whereas header and linkback are optional.

Each of the units is represented by a class in nider.models:

nider.models.Header
nider.models.Paragraph
nider.models.Linkback

`nider.models.Header`¶

class Header(text, fontfullpath, fontsize=18, text_width=21, line_padding=6, color='#000', drop_shadow=False, shadowcolor='#646464', align='center')¶

Base class for the header unit

Parameters:

text (str) – Text used in the header
fontfullpath (str) – Path to the font used in the header
text_width (int) – Header’s text width - number of characters in a line
line_padding (int) – Header’s line padding - padding (in pixels) between the lines
fontsize (int) – Size of the font
color (str or tuple(int, int, int)) – Either hex or rgb representation of text color
drop_shadow (bool) – Boolean flag that indicates if text has to drop shadow
shadowcolor (str or tuple(int, int, int)) – Either hex or rgb representation of shadowcolor color
align ('left' or 'center' or 'right') – Side with respect to which the text will be aligned

Raises:

nider.exceptions.InvalidAlignException – if align is not one of ‘left’ or ‘center’ or ‘right’
nider.exceptions.DefaultFontWarning – if fontfullpath is None
nider.exceptions.FontNotFoundWarning – if fontfullpath does not exist

Example¶

from nider.models import Header

header = Header(text='Your super interesting title!',
                fontfullpath='/home/me/.local/share/fonts/Roboto/Roboto-Bold.ttf',
                fontsize=30,
                text_width=40,
                align='left',
                color='#ededed'
                )

`nider.models.Paragraph`¶

The class has the same attribures and behaviour as nider.models.Header.

class Paragraph(text, fontfullpath, fontsize=18, text_width=21, line_padding=6, color='#000', drop_shadow=False, shadowcolor='#646464', align='center')¶

Base class for the paragraph unit

Parameters:

text (str) – Text used in the paragraph
fontfullpath (str) – Path to the font used in the paragraph
text_width (int) – Paragraph’s text width - number of characters in a line
line_padding (int) – Paragraph’s line padding - padding (in pixels) between the lines
fontsize (int) – Size of the font
color (str or tuple(int, int, int)) – Either hex or rgb representation of text color
drop_shadow (bool) – Boolean flag that indicates if text has to drop shadow
shadowcolor (str or tuple(int, int, int)) – Either hex or rgb representation of shadowcolor color
align ('left' or 'center' or 'right') – Side with respect to which the text will be aligned

Raises:

nider.exceptions.InvalidAlignException – if align is not one of ‘left’ or ‘center’ or ‘right’
nider.exceptions.DefaultFontWarning – if fontfullpath is None
nider.exceptions.FontNotFoundWarning – if fontfullpath does not exist

Example¶

from nider.models import Paragraph

para = Paragraph(text='Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.',
                fontfullpath='/home/me/.local/share/fonts/Roboto/Roboto-Medium.ttf',
                 fontsize=29,
                 text_width=65,
                 align='left',
                 color='#ededed'
                 )

`nider.models.Linkback`¶

class Linkback(text, fontfullpath, fontsize=18, color='#000', drop_shadow=False, shadowcolor='#646464', align='center', bottom_padding=20)¶

Base class for the linkback unit

Parameters:

text (str) – Text used in the linkback
fontfullpath (str) – Path to the font used in the linkback
fontsize (int) – Size of the font
color (str or tuple(int, int, int)) – Either hex or rgb representation of text color
drop_shadow (bool) – Boolean flag that indicates if text has to drop shadow
shadowcolor (str or tuple(int, int, int)) – Either hex or rgb representation of shadowcolor color
align ('left' or 'center' or 'right') – Side with respect to which the text will be aligned
bottom_padding (int) – Linkback’s bottom padding - padding (in pixels) between the bottom of the image and the linkback itself

Raises:

nider.exceptions.InvalidAlignException – if align is not one of ‘left’ or ‘center’ or ‘right’
nider.exceptions.DefaultFontWarning – if fontfullpath is None
nider.exceptions.FontNotFoundWarning – if fontfullpath does not exist

Example¶

from nider.models import Linkback

linkback = Linkback(text='foo.com | @username',
                    fontfullpath='/home/me/.local/share/fonts/Roboto/Roboto-Bold.ttf',
                    fontsize=24,
                    color='#ededed'
                    )

Image content¶

In order to aggregate all of the units together you need to create an instance of nider.models.Content class.

`nider.models.Content`¶

class Content(paragraph, header=None, linkback=None, padding=45)¶

Class that aggregates different units into a sigle object

Parameters:	paragraph (nider.models.Paragraph) – Paragraph that will be used header (nider.models.Header) – Header that will be used linkback (nider.models.Linkback) – Linkback that will be used padding (int) – Content’s padding - padding (in pixels) between the units

Example¶

from nider.models import Content
from nider.models import Linkback
from nider.models import Paragraph

para = Paragraph(...)

linkback = Linkback(...)

content = Content(para, linkback=linkback, padding=60)

Initializing an image¶

After the content is prepared it’s the right time to initialize an image. In nider a basic image is represented by nider.models.Image

`nider.models.Image`¶

class Image(content, fullpath, width=1080, height=1080)¶

Base class for a text based image

Parameters:	content (nider.models.Content) – Content object that has units to be rendered fullpath (str) – Path where the image has to be saved width (int) – Width of the image height (int) – Height of the image
Raises:	AttributeError – if it’s impossible to create a file at `fullpath` path AttributeError – if width <= 0 or height <= 0

Example¶

from nider.models import Content
from nider.models import Image

content = Content(...)

img = Image(content,
            fullpath='example.png',
            width=500,
            height=500
            )

Drawing on the image¶

Having an instance of nider.models.Image we are ready to create a real image.

nider comes with 3 options of drawing your image:

Image.draw_on_texture - draws preinitialized image and its attributes on a texture. nider takes care of filling image of any size with textrure you privide. You don’t need to create textured images by pasting texture mulpitle times in Photoshop or Gimp.

Image.draw_on_bg - Draws preinitialized image and its attributes on a colored background. nider uses a color you provide to fill the image and then draws the content.

Image.draw_on_image - Draws preinitialized image and its attributes on an image. Content will be drawn directly on the image you provide.

`Image.draw_on_texture`¶

draw_on_texture(texture_path=None)¶

Draws preinitiated image and its attributes on a texture. If texture_path is set to None, takes random textures from textures/

Parameters:	texture_path (str) – Path of the texture to use
Raises:	FileNotFoundError – if the file at `texture_path` cannot be found nider.exceptions.ImageSizeFixedWarning – if the image size has to be adjusted to the provided content’s size because the content takes much space

Example¶

from nider.models import Content
from nider.models import Image

content = Content(...)

img = Image(content,
            fullpath='example.png',
            width=500,
            height=500
            )

img.draw_on_texture('example_texture.png')

Check the full example here

nider comes with a huge bundle of textures. As for now you need to copy them to your machine if you want to use any of them.

`Image.draw_on_bg`¶

draw_on_bg(bgcolor=None)¶

Draws preinitiated image and its attributes on a colored background. If bgcolor is set to None, random nider.colors.colormap.FLAT_UI color is generated

Parameters:	bgcolor (str or tuple(int, int, int)) – Either hex or rgb representation of background color
Raises:	nider.exceptions.ImageSizeFixedWarning – if the image size has to be adjusted to the provided content’s size because the content takes much space

Example¶

from nider.models import Content
from nider.models import Image

content = Content(...)

img = Image(content,
            fullpath='example.png',
            width=500,
            height=500
            )

img.draw_on_bg('#efefef')

Check the full example here

`Image.draw_on_image`¶

draw_on_image(image_path)¶

Draws preinitiated image and its attributes on an image. Image size will be changed to the size of provided image.

Parameters:	image_path (str) – Path of the image to draw on
Raises:	FileNotFoundError – if the file at `image_path` cannot be found

Example¶

from nider.models import Content
from nider.models import Image

content = Content(...)

img = Image(content,
            fullpath='example.png',
            width=500,
            height=500
            )

img.draw_on_image('example_bg.jpg')

Check the full example here

That’s it. After any of draw methods has been called and successfully completed the new image will be saved to Image.fullpath.

Usage¶

Image units¶

nider.models.Header¶

Example¶

nider.models.Paragraph¶

Example¶

nider.models.Linkback¶

Example¶

Image content¶

nider.models.Content¶

Example¶

Initializing an image¶

nider.models.Image¶

Example¶

Social media images¶

Instagram¶

Facebook¶

Twitter¶

Drawing on the image¶

Image.draw_on_texture¶

Example¶

Image.draw_on_bg¶

Example¶

Image.draw_on_image¶

Example¶

`nider.models.Header`¶

`nider.models.Paragraph`¶

`nider.models.Linkback`¶

`nider.models.Content`¶

`nider.models.Image`¶

`Image.draw_on_texture`¶

`Image.draw_on_bg`¶

`Image.draw_on_image`¶