Skip to content

A tool for exporting Open Collective backer emails by tier for mailings

License

Notifications You must be signed in to change notification settings

getsolus/opencollective-export

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

41 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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. 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. 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 <org> [tier1, tier2]. If no tiers are specified, all available tiers will be exported.

Available tiers can be found using oc-export list-tiers <org>.

About

A tool for exporting Open Collective backer emails by tier for mailings

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

Packages

No packages published

Contributors 2

  •  
  •  

Languages