openselery 0.0.1.dev217

A Software-Defined Funding Distribution

Continuous and Transparent Developer Payout

OpenSelery is a decentralized framework for a free and transparent salary distribution in free software. It defines a funding distribution to generate a transparent and adaptable cash flow to your digital project and all its contributors, including your dependencies.

Please keep in mind that OpenSelery is in an experimental state right now. The amount of funding should therefore be kept to a minimum.

Features

• Transparent payout to the developers of your Github project.
• Dependency scanning for most languages to even include developers of your dependency.
• Distribution of money is done via Bitcoin (currently via coinbase).
• Investors can see a transparent payout with public CI logs.

How does OpenSelery work?

1. OpenSelery is configured based on the selery.yml file, so it runs as a CI-job in GitHub.
2. Gathers contributor information about the target project via the Github and Libraries.io API
3. Filters out contributors that not made the email address visible in the Github profile.
4. Creates a uniform weight distribution between all contributors. Custom distributions like release participation are under construction.
5. Creates an activity weight between all contributors to reward activity.
6. Sums the weights.
7. Randomly chooses contributors based on the weights.
8. Pays out Bitcoin to the chosen contributor email addresses via the Coinbase API. Contributor without a Coinbase account will get a email to claim the donation.

Demo

Continuous Integration

Use the github template to integrate OpenSelery into your in your project with a single github action file.

Command Line Usage

Create the access Tokens and Accounts

1. You will need API tokens for Github and Libraries.io. Then you can simulate payouts without the coinbase token to try it out and find the right settings. You can later add the coinbase token. Configure the access control settings of the automated coinbase account.

2. Install with docker:

cd ~
git clone https://github.com/protontypes/openselery.git
cd openselery
./build.sh

3. When you are done trying it out, create a dedicated coinbase account with limited amounts. OpenSelery is based on the APIs of Libraries.io, Github and Coinbase. Setting simulation to false (in your selery.yml) will require your coinbase tokens.

4. Never transfer or store large values with automated cryptocurrency wallets. Use recurring automated transaction from another account to recharge you wallet on a regular base.

5. Transfer some money to this wallet for testing. See the price list for transfering money into the coinbase account.

6. Create a readonly token file for your user, where you store API keys and secrets:

mkdir ~/.openselery/
touch ~/.openselery/tokens.env
chmod 400 ~/.openselery/tokens.env

7. Add your API keys and secrets to the newly created file (~/.openselery/tokens.env). Never store these tokens in a repository.

nano 

COINBASE_TOKEN=XXXXXXXXXXXXXXXX
COINBASE_SECRET=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
GITHUB_TOKEN=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
LIBRARIES_API_KEY=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

8. Configure your distribution in the selery.yml file located in ~/.openselery/ or your <target_repository> The simulation paramter is set True by default. You will need the COINBASE_TOKEN and COINBASE_SECRET when setting Simulation to False in your selery.yml. You can use the selery.yml template from the OpenSelery project, modifiy it and copy it into you <target_repository>.

Clone OpenSelery

git clone https://github.com/protontypes/openselery.git

Fund the target repository

This will send cryptocurrency to weighted random product contributors with a valid email address on the git platform (GitHub) or git commit:

Run as dockerized Command-Line Tool

env $(cat ~/.openselery/tokens.env) ~/openselery/run.sh <target_repository>

Run nativly on Debian / Ubuntu

1. Install Dependencies

sudo apt update && apt install git ruby ruby-dev ruby-bundler build-essentail curl python3-pip
cd openselery
bundle install 
pip3 install -r requirements.txt

2. Run OpenSelery

TARGET_DIR=<target_repository> && env $(cat ~/.openselery/tokens.env) python3 selery.py --config $TARGET_DIR/selery.yml --directory $TARGET_DIR --result results

Contribution

Constributors on the master branch will probably get emails with cryptocurrency. Only git profiles with emails on the Github profile page are considered.

Knowledge Base

• Knowledge-Links

  Artwork by Miriam Winter