Creating a Flou project

1. Install docker engine if not already present.

2. Create a new folder for your Flou project:

   % mkdir my-project
   % cd my-project
   

3. Start a Python virtual environment and install Flou:

   % python3 -m venv venv
   % source venv/bin/activate
   (venv) % pip install flou
   

   Flou is currently private

   To install Flou you will need access to the flou-private repo and point to it:

   pip install -e "git+https://github.com/flou-ai/flou-private/#egg=flou&subdirectory=flou"
   

4. Create an app.py file, the entrypoint for your Flou project and a requirements.txt file for your project dependencies:

   (venv) % touch app.py
   (venv) % touch requirements.txt
   

5. Start Flou:

   (venv) % flou compose up
   

   Flou uses docker under the hood

   Flou uses docker compose to easily manage all the needed processes with a friendly wrapper via flou compose.

   Flou is currently private

   To run Flou you will need to run it in development mode or run a local docker registry.

6. Open the Flou Studio by visiting http://localhost:8001 .

7. You can find the Flou Api documentation in http://localhost:8000/docs .