Examples are Awesome

There are two things I look for whenever I check out an Opensource project or library that I want to use.

1. Screenshots (A picture is worth a thousand words).

2. Examples (Don't tell me what to do, show me how to do it).

Having a fully working example (or many examples) helps me shape my thought process.

Here are a few projects that are excellent examples of this.

1. https://github.com/prompt-toolkit/python-prompt-toolkit

A CLI framework for building rich command line interfaces. The project comes with a collection of small self-sufficient examples that showcase every feature available in the framework and a nice little tutorial.

2. https://github.com/coleifer/peewee

A small ORM for Python that ships with multiple web projects to showcase how to use the ORM effectively. I'm always overwhelmed by SqlAlchemy's documentation site. PeeWee is a breath of fresh air with a clear purpose and succinct documentation.

3. https://github.com/coleifer/huey

An asynchronous task queue for Python that is simpler than Celery and more featureful than RQ. This project also ships with an awesome set of examples that show how to integrate the task queue with Django, Flask or standalone use case.

The beauty of these examples is that they're self-documenting and show us how the different pieces in the library work with each other as well as external code outside of their library such as Flask, Django, Asyncio etc.

Examples save the users hours of sifting through documentation to piece together how to use a library.

Please include examples in your project.

Tattling

Vian: Amma, the roomba is not cleaning anything.

Yoshi: Let me check.

She finds lego pieces and strings blocking the Roomba wheels.

Yoshi: Thank you, Vian. You're right it wasn't picking up anything.

Me: Vian, did you just tattle on Roomba to your mother?


Monkey Bar

Sempi is a big fan of Leonardo Da Vinci. Ever since we got back from Italy he's been talking about the various inventions of Leonardo.

Earlier today he was playing in the park after school. Apparently, he fell down from the monkey bars trying to do something brave. Yoshi took him to the ER and the doctors announced he has a small fracture and put his arm in a sling.

He's quite despondent about the whole ordeal and told me that he wished he hadn't tried that special monkey bar maneuver. I reassured him that his sling is a badge of honor, it is a sign of bravery, it shows that he is someone who pushes the boundaries.

Me: Do you know who else is the kind of person who pushed boundaries?

Sempi: Who?

Me: Leonardo. I bet he wore a sling many times in his life.

Sempi: Yeah. But he probably knew how to use a monkey bar though.

Me: LOL!!

I have to agree with him on that one.

Captain Underpants - Potty Adventures - 2

When we were in Italy, we visited the Ufizzi museum and saw a lot of old world statues. There was one statue of a warrior holding a shield in his hand. I told the kids that it is Captain Italy who happens to be the cousin of Captain America. Obviously, neither of them believed me and Sempi groaned at my lame joke.

Recently Vian started potty training. He's proud of wearing his underwear and strikes a pose every now and then.

Me: Vian you look like Captain Underpants.

Vian: No Appa. I'm like Captain Italy, remember.

Me: Haha. Was Captain Italy wearing underpants?

Vian: No Appa. Captain Italy was wearing his penis.

Of course, I forgot that the statue was naked. All the statues were naked.

Sorry!?

Vian and I are playing legos. I accidentally drop a lego piece from the table, we both bend down to get it and bonk our heads.

Me: I am sorry, Vian.
Vian: (rubbing his head) No appa, I am sorry.
Me: I guess we're both sorry. :)
Vian: No appa. I AM SAD, SO I AM SORRY (loudly).
Me: Ok. Ok you're sorry.