PyBlade

Appearance

Installation ​

PyBlade Live is included as part of PyBlade, so installing PyBlade is the first step to using it. Follow these steps to install and set up PyBlade Live in your project.

Install PyBlade ​

Before using PyBlade Live, ensure you have a Python virtual environment set up. If you haven’t already created one, do so using:

bash
python -m venv .env

Then, activate the virtual environment by running:

On macOS or Linux

bash
source .env/bin/activate

On Windows

bash
.env\Scripts\activate

Once the virtual environment is activated, install PyBlade with:

bash
pip install pyblade

After installation, check if PyBlade is installed correctly by running:

bash
pyblade -v

This will display the installed version of PyBlade, confirming the installation was successful.

Initialize a PyBlade project ​

PyBlade Live works within a PyBlade project. To start a new PyBlade project, run the following command:

sh
pyblade init

During initialization, PyBlade will prompt you with several configuration options, including:

  • Use PyBlade Live? (Yes/No)

If you choose Yes, PyBlade Live will be installed and configured automatically. If you select No, you can enable it later.

Tip

You can learn more about PyBlade installation and configuration as well as project initialization in the Getting started section of PyBlade documentation.

Enable PyBlade Live in an existing project ​

If you accidently chosed not to enable PyBlade Live during pyblade init, or if you have an existing PyBlade project without PyBlade Live configuration and now want to add it, you can do so by running:

sh
pyblade live:install

This command will add the necessary PyBlade Live configuration to your project to ensure that your PyBlade templates support PyBlade Live components and real-time component interaction.

Manual configuration (Optional) ​

For those who are curious or prefer a more hands-on setup, you can manually configure PyBlade Live in your project.

If you want to use PyBlade Live in your Django project, add it to the list of installed apps in settings.py.

python
# settings.py
INSTALLED_APPS = [
    ...,
    pyblade.live 
]

You will also need to enable it by setting use_liveblade to true in the pyblade.json file.

json
{   
    "use_liveblade": true,
}

Warning

For this to work, you must ensure you're project is configured to use the PyBlade Template Engine. This is setup automatically when you initialize a new PyBlade project with the pyblade init command. But if you have an old Django project and would like to use PyBlade Template Engine, please check our Migration guide.

After completing these steps, your Django project will be ready to use PyBlade Live, allowing you to build dynamic and interactive components without living the Python comfort.

Ready ? ​

With PyBlade Live installed, you are now ready to create components that bring interactivity to your PyBlade-powered applications. In the next section, we will explore how to define and use PyBlade Live components.

Let's start !