> For the complete documentation index, see [llms.txt](https://of-scraper.gitbook.io/of-scraper/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://of-scraper.gitbook.io/of-scraper/installation.md).

# Install

***

## Version Info

{% hint style="info" %}

#### Stable versions are hosted on various platform including PYPI,Docker, and GitHub

{% endhint %}

{% hint style="info" %}
**Go to** [**https://pypi.org/project/ofscraper/#history**](https://pypi.org/project/ofscraper/#history) **for latest Dev release**
{% endhint %}

[![drawing](https://img.shields.io/pypi/v/ofscraper.svg?color=dark_green\&label=Stable-Release)](https://pypi.org/project/ofscraper/)

[![drawing](https://img.shields.io/badge/Pre--Release-v3.70.dev-dark_green.svg)](https://pypi.org/project/ofscraper/3.7.0.dev0/)

##

***

## Before Starting

The guide assumes you have your terminal program open and have already installed Python. If you're unsure about this, follow this guide

{% content-ref url="/pages/zujPGZy9YlJnkCAPm4bh" %}
[Installing Prerequisites](/of-scraper/installation/pre-install-guide.md)
{% endcontent-ref %}

***

## Install via a package manager

{% hint style="info" %}
**pipx is recommended for its virtual environment management capabilities.**

**It serves as an abstraction layer over pip, placing installed scripts within isolated virtual environments. This approach is highly recommended for script installation as it offers several advantages:**

* **Prevents conflicts:** By isolating scripts and their dependencies within virtual environments, pipx effectively eliminates conflicts with other Python packages or system-wide installations.
* **Enhances organization:** Each script resides in its own distinct virtual environment, promoting better organization and clarity in project management.
* **Simplifies updates:** pipx streamlines the process of updating scripts, ensuring you always have access to the latest versions and features
  {% endhint %}

### **Option 1: PIPX Install**

{% content-ref url="/pages/GFOPfphuOz6Paj4gMp72" %}
[UV Install](/of-scraper/installation/uv-install.md)
{% endcontent-ref %}

### **Option 2: PIP install**

{% content-ref url="/pages/egPaGfPMHpllXupdJAf4" %}
[Broken mention](broken://pages/egPaGfPMHpllXupdJAf4)
{% endcontent-ref %}

## Install via Docker

{% content-ref url="/pages/7Fateuss7recq2YkOKgG" %}
[Docker](/of-scraper/installation/docker.md)
{% endcontent-ref %}

## Compiled Binaries \[No Install]

{% hint style="info" %}
**A pyinstaller based binary is an executable file that contains your Python script and all the necessary dependencies to run it on different operating systems. Pyinstaller analyzes the script and bundles it with the Python interpreter, libraries, modules, and other resources into a single file or folder**
{% endhint %}

{% hint style="info" %}
**Support for issues specific to how pyinstaller operates may be limited**
{% endhint %}

{% content-ref url="/pages/myOqSCAlan8sE0zrTyUW" %}
[Binary Releases](/of-scraper/installation/binary-releases.md)
{% endcontent-ref %}

***

## Basic Install/Tutorial

{% hint style="info" %}
**A quick high level tutorial of the install process**
{% endhint %}

{% embed url="<https://bunkrr.su/v/scraper-l3eS0Abl.mkv>" %}
**A video showing the install process**
{% endembed %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://of-scraper.gitbook.io/of-scraper/installation.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.