Install requirements

Set up the local tools you need before running the export.

PluralBridge currently uses local scripts. This page explains what to install, what to download, and what to have ready before you move to the Run page.

Next: Run the export Help me choose a path

What this page is for

Use this page to get the local setup ready. After this page, you should have Python installed, a Bash-compatible shell available, the PluralBridge files on your computer, and your Simply Plural API token ready to use.

This setup keeps the export on your computer. This website does not collect your token or receive your exported Simply Plural data.

Step 1: Install Python 3

Python 3 runs the current PluralBridge export scripts. Install Python 3 for the operating system on the computer you will use for the export.

Windows: install Python 3 from Python for Windows.
macOS: install Python 3 from Python for macOS if it is not already available.
Linux: install Python 3 using your distribution package manager if needed, or start from Python downloads.

During installation on Windows, enable the option that adds Python to PATH when it is offered. That makes the python command available from the shell.

Step 2: Choose your command-line path

PluralBridge currently runs from a desktop or laptop command line. Choose the path that matches the computer you are using.

Windows

Install Git for Windows from Git for Windows if you need Git Bash.
Use Git Bash for the commands on the Run page.

macOS

Use Terminal for the commands on the Run page.
Install Git from Git for macOS only if you want to clone or update the repository with Git.

Linux

Use your normal terminal for the commands on the Run page.
Install Git using your distribution package manager if needed, or start from Git for Linux.

Another desktop or laptop setup

If you use a desktop or laptop setup that is not covered here, contact [email protected].

Mobile-only export is not the current PluralBridge path.

Step 3: Get the PluralBridge files

The PluralBridge files are published on GitHub:

https://github.com/needsofmany/PluralBridge

A trusted technical helper may use Git to clone or update the repository. A regular user doing a one-time export may be able to download the ZIP file from GitHub instead.

Step 4: Create your Simply Plural API token

The export scripts need a Simply Plural API token created from inside your own Simply Plural account. The token lets the local script read your data so it can save a copy on your computer.

Treat the token like a password. Do not post it publicly, commit it to GitHub, or send it to anyone you do not trust with access to your Simply Plural data.

Step 5: Go to the Run page

When Python, a shell, the PluralBridge files, and your token are ready, continue to the Run page. That page explains how to start the export and what successful output should look like.

Next: Run the export Review safety guidance

Current requirements checklist

A computer where you can install and run command-line software.
Python 3, used by the current export scripts.
A Bash-compatible shell such as Git Bash on Windows.
The PluralBridge files from GitHub.
A Simply Plural API token created by the user from inside their Simply Plural account.

Git is helpful for developers and trusted helpers who want to download or update the repository directly. If you downloaded the ZIP file from GitHub, you may not need Git for a one-time export.