bridgy-fed/README.md

6.4 KiB

Bridgy Fed Circle CI Coverage Status

Got an IndieWeb site? Want to interact with people on Mastodon, GNU Social, and more? Bridgy Fed is for you.

https://fed.brid.gy/

Bridgy Fed connects the IndieWeb with federated social networks using ActivityPub and OStatus:

Original design docs:

License: This project is placed in the public domain.

Development

You'll need the App Engine Python SDK version 1.9.15 or later (for vendor support) or the Google Cloud SDK (aka gcloud) with the gcloud-appengine-python and gcloud-appengine-python-extras components. Add it to your $PYTHONPATH, e.g. export PYTHONPATH=$PYTHONPATH:/usr/local/google_appengine, and then run:

virtualenv local
source local/bin/activate
pip install -r requirements.txt
python -m unittest discover

The last command runs the unit tests. If you send a pull request, please include (or update) a test for the new functionality!

If you hit an error during setup, check out the oauth-dropins Troubleshooting/FAQ section. For searchability, here are a handful of error messages that have solutions there:

bash: ./bin/easy_install: ...bad interpreter: No such file or directory

ImportError: cannot import name certs

ImportError: No module named dev_appserver

ImportError: cannot import name tweepy

File ".../site-packages/tweepy/auth.py", line 68, in _get_request_token
  raise TweepError(e)
TweepError: must be _socket.socket, not socket

error: option --home not recognized

You may need to change granary, oauth-dropins, webmention-tools, mf2util, or other dependencies as well as as Bridgy Fed. To do that, clone their repo locally, then install them in "source" mode with e.g.:

pip uninstall -y granary
pip install -e <path to granary>
ln -s <path to granary>/granary \
  local/lib/python2.7/site-packages/granary

The symlinks are necessary because App Engine's vendor module evidently doesn't follow .egg-link or .pth files. :/

To deploy to App Engine, run:

gcloud -q app deploy --project bridgy-federated *.yaml

Compatibility

Here are in progress notes on how I'm testing interoperability with various federated social networks.

ActivityPub

Salmon