Home

Welcome to the Pyttman wiki!

Pyttman is a framework for developing digital assistants, chatbots or other language driven applications.

It is inspired by Django in a few design aspects and the developer experience, and aspires to offer a similar ease of use but for chatbots / digital assistants.

The goal with Pyttman is to enable developers as little friction and complexity as possible when they set out to develop chat bots, digital assistants or otherwise natural-languate-powered apps.

They should not have to bother with the nasty complexity of parsing text and figuring out how to integrate with different plattforms and keeping apps follow a design pattern.

We strive to bring them the power to focus on building digital assistant apps and let Pyttman take care of the boring parts.

A few bullet points are:

• Bundled with client classes already written and integrated with the framework, so you can focus on building your app and have it online on Discord with the ready-made DiscordClient.

• Develop your app once and chat with it on muliple platforms simultaneously by using multiple Client configurations in settings.py.

• No more tangled if-statements for deciphering a user command based on certain words.

• API's for internal storage management, identifying entities (information in natural languare), scheduling of function / method calls,

• 100% object-oriented with base classes for subclassing as an alternative to using the presets.

• A clear and consice structure for how your app can be built and scale, with a directory structure set up for you.

• Offers a familiar syntax for developers with previous experience in Django

• Easy to use for simple projects - powerful and flexible for more complex projects

• Contains logging, scheduling and built-in client support for major platforms

Get started

It's very easy to get started with Pyttman.

1. Install it using pip: pip install pyttman
2. Navigate to the directory where you want to develop your Pyttman app
3. Start a project using the command pyttman-cli newapp <app_name>
4. You now have a template Pyttman app. Run it with the shell client using pyttman-cli dev <app_name>, or add clients to settings.py and have your digital assistant app up in seconds.
5. Consult the documentation for guidance on how to use Pyttman to its full potential by integrating your app with a chat service or your own website.

Documentation is on the board right now and is being written as quickly as possible. In the mean time, if you just can't wait - check out this template example app on how to get an idea of how to start using Pyttman.