Installation

DocETL can be easily installed using pip, Python's package installer, or from source. Follow these steps to get DocETL up and running on your system:

Prerequisites

Before installing DocETL, ensure you have Python 3.10 or later installed on your system. You can check your Python version by running:

Installation via pip

1. Install DocETL using pip:

If you want to use the parsing tools, you need to install the parsing extra:

This command will install DocETL along with its dependencies as specified in the pyproject.toml file. To verify that DocETL has been installed correctly, you can run the following command in your terminal:

Installation from Source

To install DocETL from source, follow these steps:

1. Clone the repository:

1. Install uv (if not already installed):

1. Install the project dependencies and DocETL:

If you want to use only the parsing extra:

1. Set up your OpenAI API key:

Create a .env file in the project root and add your OpenAI API key:

Alternatively, you can set the OPENAI_API_KEY environment variable in your shell.

1. Run the basic test suite to ensure everything is working (this costs less than $0.01 with OpenAI):

Troubleshooting

If you encounter any issues during installation, please ensure that:

• Your Python version is 3.10 or later
• You have the latest version of pip installed
• Your system meets all the requirements specified in the pyproject.toml file

For further assistance, please refer to the project's GitHub repository or reach out on the Discord server.