carefree-drawboard 🎨

✨ Build performant, business ready web apps in pure Python.

Documentation | Examples

Installation

carefree-drawboard 🎨 requires the following to get started:

• Python 3.8+
• Node.js 18+

To be exact, we need ^14.13.1 || ^16 || >=18 because of the tsconfck@2.1.1 package.

pip install carefree-drawboard
npm install --global yarn

Although we'll always try to help you install the frontend packages, it is recommended to install them beforehands because you can receive much more verbose:

cfdraw install

If you are interested in the latest features, you may use pip to install from source as well:

git clone https://github.com/carefree0910/carefree-drawboard.git
cd carefree-drawboard
pip install -e .

Your first carefree-drawboard 🎨 App

Create a folder (e.g., my_fancy_app) wherever you like, get into it, and run

cfdraw init

This command will write two files to your folder (my_fancy_app). After which you can run the app in development mode:

cfdraw run

When you run this command for the first time and have not called cfdraw install before, we will use yarn to install the JavaScript dependencies for you, which may be quite slow!

And you should see your app running at http://localhost:5123. Now you can play with the generated app.py file and see warm reload (yeah, not hot enough because we rely on the reload provided by uvicorn 🤣).

Notice that the generated template implements a GaussianBlur plugin, which requires an image to pop up. You can upload an image either by dragging it directly to the drawboard 🎨, or by clicking the Plus button at the top right corner and select Upload Image.

20230426-171314.mp4_20230426_171346.mp4

Examples

• Getting Started, which is a more detailed tutorial to guide you step by step.
• Image Processing, which implements three common image processing plugins. It also shows how to use the IPluginGroup in carefree-drawboard 🎨 to group the plugins together and make the UI cleaner.
• Stable Diffusion, which utilizes the famous diffusers library and implements two common SD plugins.
• Caption & Diffusion, which shows how can we combine two different kinds of models (Image Captioning & Stable Diffusion) and make them work together.
• Stable Diffusion Inpainting, which shows how can we implement complicated plugins like StableDiffusionInpainting very easily.
• Stable Diffusion ControlNet, which shows how can we decouple complicated workflows like ControlNet into separate, lightweight, and reusable plugins very easily.
• Carefree Creator, which contains a free, public-available demo of the real world business ready product we are selling. It is a web app with tons of AI magics, but still remains easy for carefree-drawboard 🎨 to implement them.

Status

carefree-drawboard 🎨 is at a VERY early stage (it is launched in April 2023), so although it could be production ready (see here for more details), it does not have many real world use cases (yet).

But we will rapidly update this project and launch new features every week (or, even everyday), so ⭐ star and 👀 watch this repository to stay up to date!

Contributing

• It might be the best to start from the Contributing page.
• If you are truly an enthusiast, you may check out our Roadmap, pick up what you are interested, and create the corresponding PR!

Style Guide

If you are still interested: carefree-drawboard 🎨 adopted black and mypy to stylize its codes, so you may need to check the format, coding style and type hint with them before your codes could actually be merged.

Q&A

Where are my creations stored?

They are stored on your local machine, so you're 100% privacy secured!

The default dir is ~/.cache/carefree-draw, but you can change it manually

Why Using 🎨 All Around?

Good question, so I asked GPT-4, it said:

🎨 (Artist Palette) - This emoji represents creativity, design, and artistic expression, which are all key aspects of the carefree-drawboard 🎨 platform.

Cool!

Will there be a Discord Community?

Many thanks to JSDu, who created a Discord channel for my projects!!

如果有热心观众对这个项目感兴趣并愿意帮忙建立一个中文社区，欢迎联系我，我会非常感激的！！

更新： 热心观众（JSDu）出现啦！非常感谢！！！（猛戳这里加入我们！）

Why do you build this project?

Also check Design Philosophy.

In short, I believe that:

• Infinite Drawboard can unleash Infinite possibilities.
• If we can use Python to interact with it and even craft new plugins for it, it will be even better.

So here comes the carefree-drawboard 🎨, which is a Python interactible/customizable Infinite Drawboard. 🎉

My another motivation is that I love HuggingFace 🤗 models, and would love to use most if not all of them in one, single, integrated space. This actually inspires me the following idea: to build an 'AI Operation System' which can drive all the 'Softwares' (the AI models) and make them work together seamlessly.

See Brainstorm for more details!

My final goal is to make carefree-drawboard 🎨 a platform which can be used to build all kinds of AI applications. I know it will be a long journey but it is definitely worth trying.

And the middle-term goal is to make 🤗 & 🎨 appear together more often. We may think 🤗🎨 as HuggingFace models using a powerful palette to create the world (with AI)!

Credits

• llunalabs, for the kindeness & community support.
• pynecone, which inspires me a lot.
• Stable Diffusion, the foundation of various image generation methods.
• Diffusers, the adopted library for the Stable Diffusion example.
• @liujs1, who provides me the nice looking icons.
• And You! Thank you for watching!