https://github.com/getsolus/opencollective-export
A tool for exporting Open Collective backer emails by tier for mailings
https://github.com/getsolus/opencollective-export
Last synced: 4 months ago
JSON representation
A tool for exporting Open Collective backer emails by tier for mailings
- Host: GitHub
- URL: https://github.com/getsolus/opencollective-export
- Owner: getsolus
- License: mpl-2.0
- Created: 2025-11-15T05:49:26.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2026-01-11T05:37:26.000Z (5 months ago)
- Last Synced: 2026-01-11T12:43:39.716Z (5 months ago)
- Language: Python
- Size: 103 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# opencollective-export
A simple CLI tool to export backer data from Open Collective. Current list of features:
- List available backer tiers for a given organization.
- List backers for a given organization.
- Export mailing-list-ready CSV files per backer tier.
## Installation
### Solus
This program is available from the Solus repository. To install it, run:
```
sudo eopkg install opencollective-export
```
### Other Linux Distributions
This program is available [from PyPI](https://pypi.org/project/opencollective-export/). As such, it can easily be installed with `pipx`:
```
pipx install opencollective-export
```
## Development Setup
1. Clone this repository somewhere and `cd` into it.
2. Create a virtual environment: `python3 -m venv .venv`.
3. Activate your virtual environment: `source .venv/bin/activate`.
4. Install the project locally: `pip install -e .`. This will install an editable copy, so you can hack without having to reinstall all the time!
## Usage
Most of this program's documentation lives in its built-in help. Run commands with `--help` to see detailed usage. Here are a few brief examples:
> [!Note]
> All operations require the use of an Open Collective [personal token](https://documentation.opencollective.com/development/personel-tokens). Please create one before continuing
> Current operations are possible using only the "account" scope. For security, don't add any others.
Once you have your token, add it to the system keyring with `oc-export set-token`.
The usual operation (getting mailing list CSVs for each backer tier) is very simple: `oc-export export [tier1, tier2]`. If no tiers are specified, all available tiers will be exported.
Available tiers can be found using `oc-export list-tiers `.