Install collective.html2blocks

This guide shows you how to add collective.html2blocks to your Python project. The package requires Python 3.12 or later. Choose the method that matches your project.

Choose the extras you need

The base package installs the converter only: the functions html_to_blocks(), markdown_to_blocks() and volto_blocks(). Install an extra to add the command line or the HTTP service:

Extra	Installs	Needed for
cli	typer	The html2blocks command, with the convert and info commands
server	typer, fastapi[standard]	The server command and the HTTP service
all	Both sets	The command and the service together

Write the extra in square brackets after the package name, for example collective.html2blocks[server]. If you run html2blocks without its extra, the command prints the name of the extra to install and exits.

1. pyproject.toml

   Use this method for modern Python projects. Add collective.html2blocks to the dependencies list in your pyproject.toml file. This approach works with build tools such as uv, Poetry, or any other PEP 621-compliant tool.

   [project]
   dependencies = [
       "collective.html2blocks",
   ]
   

2. setup.py

   Use this method for traditional setuptools projects. Add collective.html2blocks to the install_requires list in your setup.py file.

   setup(
       # ...
       install_requires=[
           "collective.html2blocks",
       ],
   )
   

3. requirements.txt

   Use this method if your project manages dependencies with pip. Add collective.html2blocks to your requirements.txt file.

   collective.html2blocks
   

Reinstall with updated dependencies

After you change your dependency file, run your project's installation command again. For example, run pip install -r requirements.txt or uv sync, or use the equivalent command of your build tool.

To learn how to write version constraints, read the Dependency specifiers specification.