Installation

This guide will help you install the forex_data package and all its dependencies.

Prerequisites

Before installing forex_data, make sure you have:

Note

uv is the recommended way to manage this package. If you don’t have uv installed, visit the uv documentation for installation instructions.

To install uv, run:

curl -LsSf https://astral.sh/uv/install.sh | sh

Or on Windows PowerShell:

powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

The easiest way to install forex_data is from PyPI:

uv pip install forex-data-aggregator

Or using pip:

pip install forex-data-aggregator

This will install the latest stable version with all dependencies.

Note

After installation, you can import the package as import forex_data

If you want to contribute to development or use the latest features:

First, clone the forex_data repository:

git clone https://github.com/nikfio/forex_data.git -b master forex-data
cd forex-data

Ensure you have uv installed:

curl -LsSf https://astral.sh/uv/install.sh | sh

Use uv to synchronize the environment and install all dependencies:

uv sync

This will:

Run the test suite to ensure everything is working correctly:

uv run pytest

If all tests pass, your installation is successful! ✅

For development work including documentation tools, install with development dependencies:

uv sync --group dev

This includes additional tools for:

For a standard environment with core project dependencies:

uv sync --no-dev

The package has the following main dependencies:

See pyproject.toml for the complete list of dependencies.

Now that you have installed forex_data, you can:

If you encounter any issues during installation, please check our GitHub Issues page.