Welcome to osfclient’s documentation!

The osfclient is a python library and a command-line client for up- and downloading files to and from your Open Science Framework projects. The Open Science Framework (OSF) is an open source project which facilitates the open collaboration of researchers on the web, by sharing data and other research outputs.

As such the OSF hosts large data sets, associated with papers or scientific projects, that can be freely downloaded. The osfclient allows people to store and retrieve large datasets associated to their scientific projects and papers on the OSF via the command line interface. If you are completely new to the OSF you can read the OSF introductory materials.

This is a very new project, it has some rough edges. You can find the code for the osfclient in the GitHub repository.

Contents:

• User’s Guide
• API Reference
  • osfclient.cli
  • osfclient.utils
  • osfclient.models