{"id":14036943,"url":"https://github.com/CenterForOpenScience/waterbutler","last_synced_at":"2025-07-27T04:33:08.819Z","repository":{"id":23755745,"uuid":"27130042","full_name":"CenterForOpenScience/waterbutler","owner":"CenterForOpenScience","description":"WaterButler is a Python web application for interacting with various file storage services via a single RESTful API, developed at Center for Open Science.","archived":false,"fork":false,"pushed_at":"2024-01-05T05:44:48.000Z","size":27714,"stargazers_count":61,"open_issues_count":35,"forks_count":73,"subscribers_count":16,"default_branch":"develop","last_synced_at":"2024-04-27T23:32:29.003Z","etag":null,"topics":["async","openscience","python","science","storage-provider","tornado"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CenterForOpenScience.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2014-11-25T14:42:31.000Z","updated_at":"2024-02-18T02:23:42.000Z","dependencies_parsed_at":"2024-01-29T07:55:23.684Z","dependency_job_id":null,"html_url":"https://github.com/CenterForOpenScience/waterbutler","commit_stats":null,"previous_names":[],"tags_count":169,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CenterForOpenScience%2Fwaterbutler","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CenterForOpenScience%2Fwaterbutler/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CenterForOpenScience%2Fwaterbutler/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CenterForOpenScience%2Fwaterbutler/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CenterForOpenScience","download_url":"https://codeload.github.com/CenterForOpenScience/waterbutler/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":214982086,"owners_count":15811653,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["async","openscience","python","science","storage-provider","tornado"],"created_at":"2024-08-12T03:02:20.754Z","updated_at":"2024-08-12T03:06:11.802Z","avatar_url":"https://github.com/CenterForOpenScience.png","language":"Python","readme":"\u003cimg src=\"/docs/waterbutler.png?raw=true\" width=\"25%\" style=\"float:left;\"\u003e\n\n# WaterButler\n\n[![Documentation Status](https://readthedocs.org/projects/waterbutler/badge/?version=latest)](http://waterbutler.readthedocs.org/en/latest/?badge=latest)\n[![Code Climate](https://codeclimate.com/github/CenterForOpenScience/waterbutler/badges/gpa.svg)](https://codeclimate.com/github/CenterForOpenScience/waterbutler)\n\n`master` Build Status: [![Build Status](https://github.com/CenterForOpenScience/waterbutler/actions/workflows/test-build.yml/badge.svg?branch=master)](https://github.com/CenterForOpenScience/waterbutler/actions)[![Coverage Status](https://coveralls.io/repos/github/CenterForOpenScience/waterbutler/badge.svg?branch=master)](https://coveralls.io/github/CenterForOpenScience/waterbutler?branch=master)\n\n`develop` Build Status: [![Build Status](https://github.com/CenterForOpenScience/waterbutler/actions/workflows/test-build.yml/badge.svg?branch=develop)](https://github.com/CenterForOpenScience/waterbutler/actions)[![Coverage Status](https://coveralls.io/repos/github/CenterForOpenScience/waterbutler/badge.svg?branch=develop)](https://coveralls.io/github/CenterForOpenScience/waterbutler?branch=develop)\n\n### Compatibility\n\nWaterButler is compatible with Python 3.6.\n\n### Documentation\n\nDocumentation available at https://waterbutler.readthedocs.io/en/latest/\n\n### Setting up\n\nIn order to run WaterButler, you must create a Python 3.6-based virtualenv for it.\n\nFor MacOSX, you can install the latest version of Python3 using:\n\n```bash\nbrew install python3\n```\n\nFor Ubuntu users:\n\n```bash\napt-get install python3.6\n```\n\nAfter completing the installation of Python 3.6, you must create a virtual environment. This can be done with the following commands:\n\n```bash\npip install virtualenv\npip install virtualenvwrapper\nmkvirtualenv --python=python3.6 waterbutler\n\npip install setuptools=37.0.0\npip install invoke==0.13.0\n\ninvoke install\ninvoke server\n```\n\nThe above code will get the virtualenv up and running for the first time.  After the initial setup, you can run waterbutler by running:\n\n```bash\nworkon waterbutler\ninvoke server\n```\n\nSome tasks also require a running celery worker.  You will need to install `rabbitmq` and run a server:\n\n```bash\nbrew install rabbitmq\n# on Ubuntu:\n# apt-get install rabbitmq-server\nrabbitmq-server\n```\n\nThen in your WaterButler virtualenv:\n\n```bash\ninvoke celery\n```\n\n### Configuring\n\nWaterButler configuration is done through a JSON file (`waterbutler-test.json`) that lives in the `.cos` directory of your home directory.  If this is your first time setting up WaterButler or its sister project, [MFR](https://github.com/CenterForOpenScience/modular-file-renderer/), you probably do not have this directory and will need to create it:\n\n```bash\nmkdir ~/.cos\n```\n\nThe data in `waterbutler-test.json` is used by the many Django-style `settings.py` files sprinkled about.  Most of these files define a top-level key that its specific configuration should be listed under.  For instance, if you wanted your local WaterButler server to listen on port 8989 instead of the default 7777, you would check the settings file for `waterbutler.server`.  That file looks for `HOST` and `DOMAIN` configuration keys under the `SERVER_CONFIG` top-level key.  Your configuration file would need to be updated to look like this:\n\n```json\n{\n  \"SERVER_CONFIG\": {\n    \"PORT\": 8989,\n    \"DOMAIN\": \"http://localhost:8989\"\n  }\n}\n```\n\nIf you then wanted to update the GitHub commit message WaterButler submits when deleting files, you would look in `waterbutler.providers.github.settings`. The `DELETE_FILE_MESSAGE` parameter should come under the `GITHUB_PROVIDER_CONFIG` key:\n\n```json\n{\n  \"SERVER_CONFIG\": {\n    \"PORT\": 8989,\n    \"DOMAIN\": \"http://localhost:8989\"\n  },\n  \"GITHUB_PROVIDER_CONFIG\": {\n    \"DELETE_FILE_MESSAGE\": \"WaterButler deleted this. You're welcome.\"\n  }\n}\n```\n\n### Testing\n\nBefore running the tests, you will need to install some additional requirements. In your checkout, run:\n\n```bash\nworkon waterbutler\ninvoke install --develop\ninvoke test\n```\n\n### Known issues\n\n- **Updated, 2018-01-02:** *WB has been updated to work with setuptools==37.0.0, as of WB release v0.37. The following issue should not happen for new installs, but may occur if you downgrade to an older version.*  Running `invoke install -d` with setuptools v31 or greater can break WaterButler.  The symptom error message is: `\"AttributeError: module 'waterbutler' has no attribute '__version__'\"`.  If you encounter this, you will need to remove the file `waterbutler-nspkg.pth` from your virtualenv directory, run `pip install setuptools==30.4.0`, then re-run `invoke install -d`.\n\n- `invoke $command` results in `'$command' did not receive all required positional arguments!`: this error message occurs when trying to run WB v0.30.0+ with `invoke\u003c0.13.0`.  Run `pip install invoke==0.13.0`, then retry your command.\n\n### License\n\nCopyright 2013-2018 Center for Open Science\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n\n### COS is hiring!\n\nWant to help save science? Want to get paid to develop free, open source software? [Check out our openings!](https://cos.io/our-communities/jobs/)\n","funding_links":[],"categories":["Python"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FCenterForOpenScience%2Fwaterbutler","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FCenterForOpenScience%2Fwaterbutler","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FCenterForOpenScience%2Fwaterbutler/lists"}