Installation

Requirements

  • Python 3.12 or higher

  • requests library

  • python-dotenv library (optional, for loading environment variables)

Installing from PyPI

The recommended way to install the OneWorldSync Python Client is from PyPI:

pip install oneworldsync

This will install the latest stable version of the package along with its dependencies.

Installing from Source

You can also install the package directly from the source code:

git clone https://github.com/mcgarrah/oneworldsync_python.git
cd oneworldsync_python
pip install -e .

Development Installation

If you want to contribute to the development of the package, you can install it with development dependencies:

pip install -e ".[dev]"

Or using the requirements files:

pip install -r requirements-dev.txt

Documentation Installation

To build the documentation locally, install the package with documentation dependencies:

pip install -e ".[docs]"

Or using the requirements file:

pip install -r requirements-docs.txt