OSF Addon Service (Milkmaid) - WaterButler Mk2

Welcome to the Open Science Framework's base server for addon integration with our RESTful API (osf.io). This server acts as a gateway between the OSF and external APIs. Authenticated users or machines can access various resources through common file storage and citation management APIs via the OSF. Institutional members can also add their own integrations, tailoring addon usage to their specific communities.

Setting up Milkmaid Locally

1. Add your secrets to app/settings/my_secrets/secrets.py.
2. Start your PostgreSQL and Django containers with docker-compose up -d.
3. Enter the Django container: docker exec addon_service /bin/bash.
4. Migrate the existing models: python3 manage.py migrate.
5. Visit http://0.0.0.0:8000/.

Running Tests

To run tests, use the following command:

python3 manage.py test

Development Tips

Optionally, but recommended: Set up pre-commit hooks that will run formatters and linters on staged files. Install pre-commit using:

pip install pre-commit

Then, run:

pre-commit install --allow-missing-config

Reporting Issues and Questions

If you encounter a bug, have a technical question, or want to request a feature, please don't hesitate to contact us at help@osf.io. While we may respond to questions through other channels, reaching out to us at help@osf.io ensures that your feedback goes to the right person promptly. If you're considering posting an issue on our GitHub issues page, we recommend sending it to help@osf.io instead.