Skip to main content
Version: 0.1.21 (Current)

Installation

Requirements

  • Python 3.8 or higher
  • pip package manager

Installing from GitHub

The recommended way to install is via pip from GitHub:

pip install git+https://github.com/312-dev/monarchmoney.git

This will install the monarchmoney package along with all required dependencies.

Installing from Source

For development or to get the latest features:

# Clone the repository
git clone https://github.com/312-dev/monarchmoney.git
cd monarchmoney

# Install in development mode
pip install -e .

Dependencies

The library requires the following packages (automatically installed):

PackagePurpose
aiohttpAsync HTTP client for API requests
gql[aiohttp]GraphQL client library
oathtoolTOTP/HOTP token generation for MFA

Verifying Installation

After installation, verify everything works:

import asyncio
from monarchmoney import MonarchMoney

print("monarchmoney installed successfully!")

# Check version
import monarchmoney
print(f"Version: {monarchmoney.__version__}")

Upgrading

To upgrade to the latest version:

pip install --upgrade git+https://github.com/312-dev/monarchmoney.git

Troubleshooting

SSL Certificate Errors

If you encounter SSL certificate errors, you may need to update your certificates:

pip install --upgrade certifi

Import Errors

If you get import errors for gql or aiohttp, ensure all dependencies are installed:

pip install aiohttp gql[aiohttp] oathtool

Permission Errors

If you encounter permission errors during installation, use --user flag:

pip install --user git+https://github.com/312-dev/monarchmoney.git

Or use a virtual environment (recommended):

python -m venv venv
source venv/bin/activate # On Windows: venv\Scripts\activate
pip install git+https://github.com/312-dev/monarchmoney.git