.. image:: LOGO/osf-cli-logo-v1-small.png
:alt: osfclient
:align: right
*********
osfclient
*********
|travisbadge|
The ``osfclient`` is a python library and a command-line client for up-
and downloading files to and from your `Open Science
Framework <//osf.io>`__ 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 their
introductory materials <https://cos.io/our-products/osf>`__
This is a very new project, it has some rough edges.
.. |travisbadge| image:: https://travis-ci.org/osfclient/osfclient.svg?branch=master
:target: https://travis-ci.org/osfclient/osfclient
Installing
==========
To use ``osfclient`` install it via pip:
::
$ pip install osfclient
For details on participating in the development of ``osfclient`` check
out the `Contributing
section <https://github.com/osfclient/osfclient#contributing>`__.
Usage
=====
This project provides two things: a python library and a command-line
program for interacting with files stored in the
`OSF <https://osf.io/>`__.
The python library forms the basis for the command-line program. If you
want programmatic access to your files use the library, otherwise try
out the command-line program.
Read the full documentation: https://osfclient.readthedocs.io/en/latest/
Below are some examples on how to use it:
::
# get help and see available commands, get help on a specific command
$ osf -h
$ osf <command> -h
# setup a local folder for an existing project
$ osf init
# list all files for the project
$ osf ls
# fetch all files for the project
$ osf clone
# fetch an individual file from a project
$ osf fetch remote/path.txt local/file.txt
# get web view url for an individual file from a project
$ osf geturl remote/path.txt
# add a new file
$ osf upload local/file.txt remote/path.txt
# add a new directory
$ osf upload -r local/directory/ remote/directory
If the project is private you will need to provide authentication
details. You can provide either username & password credentials or a
Personal Access Token (PAT). You can provide these by setting either
the ``OSF_USERNAME`` and ``OSF_PASSWORD`` environment variables or by
setting the ``OSF_TOKEN`` environment variable. The password will be
retrieved from the ``OSF_PASSWORD`` environment variable or you will
be asked directly by the tool when you run it.
You can set default values for the username and project by using a
configuration file in the current directory. This is what ``osf init``
does for you. To set the username and project ID create
``.osfcli.config``:
::
[osf]
username = yourOSFaccount@example.com
project = 9zpcy
To avoid having to provide credentials on each use, you can provide
either your password or a PAT in your config with the following keys:
::
# basic auth (username/password)
password = this-password-is-fake
# token auth
token = kej2R9IU6Gr2uThsswSNdP1cd0cu9eaCerVXjVf7zNwfXHyT0QzMZtX0PGTYmp9Fzaixwq
After which you can simply run ``osf ls`` to list the contents of the
project.
Contributing
============
Contributions from everyone and anyone are welcome. Fork this
repository, make your changes, add a test to cover them and create a
Pull Request. Then one of the maintainers will review your changes. When
all comments have been addressed and all tests pass your changes will be
merged.
To setup a development version:
::
$ git clone https://github.com/YOURNAMEHERE/osfclient
$ git remote add upstream https://github.com/osfclient/osfclient
$ cd osfclient
$ pip install -r devRequirements.txt -c constraints.txt
$ pip install -e . -c constraints.txt
There are a few secret keys relevant to this project, like passwords to
pypi.org, test.pypi.org, and the osfclient email account. We store these in an
encrypted git repo on `Keybase <//keybase.io>`__. If you need access to this
repo, contact any of the following maintainters on Keybase:
- Tim Head (@betatim)
- Ben Lindsay (@benlindsay)
- Fitz Elliott (@felliott)
- Longze Chen (@cslzchen)
For more details and instructions: `CONTRIBUTING.md <CONTRIBUTING.md>`__
Raw data
{
"_id": null,
"home_page": "https://github.com/osfclient/osfclient",
"name": "osfclient",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "The osfclient authors",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/ea/51/9e3668e8f6871fdd6aaf9c32890faea38c5b7cbc47e0c8283b05171c3f4a/osfclient-0.0.5.tar.gz",
"platform": "",
"description": ".. image:: LOGO/osf-cli-logo-v1-small.png\n :alt: osfclient\n :align: right\n\n*********\nosfclient\n*********\n\n|travisbadge|\n\nThe ``osfclient`` is a python library and a command-line client for up-\nand downloading files to and from your `Open Science\nFramework <//osf.io>`__ projects. The *Open Science Framework* (OSF) is\nan open source project which facilitates the open collaboration of\nresearchers on the web, by sharing data and other research outputs.\n\nAs such the OSF hosts large data sets, associated with papers or\nscientific projects, that can be freely downloaded. The *osfclient*\nallows people to store and retrieve large datasets associated to their\nscientific projects and papers on the OSF via the command line\ninterface. If you are completely new to the OSF you can `read their\nintroductory materials <https://cos.io/our-products/osf>`__\n\nThis is a very new project, it has some rough edges.\n\n.. |travisbadge| image:: https://travis-ci.org/osfclient/osfclient.svg?branch=master\n :target: https://travis-ci.org/osfclient/osfclient\n\nInstalling\n==========\n\nTo use ``osfclient`` install it via pip:\n\n::\n\n $ pip install osfclient\n\nFor details on participating in the development of ``osfclient`` check\nout the `Contributing\nsection <https://github.com/osfclient/osfclient#contributing>`__.\n\nUsage\n=====\n\nThis project provides two things: a python library and a command-line\nprogram for interacting with files stored in the\n`OSF <https://osf.io/>`__.\n\nThe python library forms the basis for the command-line program. If you\nwant programmatic access to your files use the library, otherwise try\nout the command-line program.\n\nRead the full documentation: https://osfclient.readthedocs.io/en/latest/\n\nBelow are some examples on how to use it:\n\n::\n\n # get help and see available commands, get help on a specific command\n $ osf -h\n $ osf <command> -h\n\n # setup a local folder for an existing project\n $ osf init\n\n # list all files for the project\n $ osf ls\n\n # fetch all files for the project\n $ osf clone\n\n # fetch an individual file from a project\n $ osf fetch remote/path.txt local/file.txt\n\n # get web view url for an individual file from a project\n $ osf geturl remote/path.txt\n\n # add a new file\n $ osf upload local/file.txt remote/path.txt\n\n # add a new directory\n $ osf upload -r local/directory/ remote/directory\n\nIf the project is private you will need to provide authentication\ndetails. You can provide either username & password credentials or a\nPersonal Access Token (PAT). You can provide these by setting either\nthe ``OSF_USERNAME`` and ``OSF_PASSWORD`` environment variables or by\nsetting the ``OSF_TOKEN`` environment variable. The password will be\nretrieved from the ``OSF_PASSWORD`` environment variable or you will\nbe asked directly by the tool when you run it.\n\nYou can set default values for the username and project by using a\nconfiguration file in the current directory. This is what ``osf init``\ndoes for you. To set the username and project ID create\n``.osfcli.config``:\n\n::\n\n [osf]\n username = yourOSFaccount@example.com\n project = 9zpcy\n\nTo avoid having to provide credentials on each use, you can provide\neither your password or a PAT in your config with the following keys:\n\n::\n\n # basic auth (username/password)\n password = this-password-is-fake\n\n # token auth\n token = kej2R9IU6Gr2uThsswSNdP1cd0cu9eaCerVXjVf7zNwfXHyT0QzMZtX0PGTYmp9Fzaixwq\n\nAfter which you can simply run ``osf ls`` to list the contents of the\nproject.\n\nContributing\n============\n\nContributions from everyone and anyone are welcome. Fork this\nrepository, make your changes, add a test to cover them and create a\nPull Request. Then one of the maintainers will review your changes. When\nall comments have been addressed and all tests pass your changes will be\nmerged.\n\nTo setup a development version:\n\n::\n\n $ git clone https://github.com/YOURNAMEHERE/osfclient\n $ git remote add upstream https://github.com/osfclient/osfclient\n $ cd osfclient\n $ pip install -r devRequirements.txt -c constraints.txt\n $ pip install -e . -c constraints.txt\n\nThere are a few secret keys relevant to this project, like passwords to\npypi.org, test.pypi.org, and the osfclient email account. We store these in an\nencrypted git repo on `Keybase <//keybase.io>`__. If you need access to this\nrepo, contact any of the following maintainters on Keybase:\n\n- Tim Head (@betatim)\n- Ben Lindsay (@benlindsay)\n- Fitz Elliott (@felliott)\n- Longze Chen (@cslzchen)\n\nFor more details and instructions: `CONTRIBUTING.md <CONTRIBUTING.md>`__\n\n\n",
"bugtrack_url": null,
"license": "BSD3",
"summary": "An OSF command-line library",
"version": "0.0.5",
"project_urls": {
"Homepage": "https://github.com/osfclient/osfclient"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a87a8d6fe30d424329ced46a738faaea4150efb8eee656599b88a791cf7ad07e",
"md5": "6574953f9b15d11c8412b0f5c67be2fc",
"sha256": "2351a61785f2ad662f1f4e7775d77dc4c185379473553f46fbfcfb65da819b80"
},
"downloads": -1,
"filename": "osfclient-0.0.5-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "6574953f9b15d11c8412b0f5c67be2fc",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 39135,
"upload_time": "2021-02-05T17:57:02",
"upload_time_iso_8601": "2021-02-05T17:57:02.252496Z",
"url": "https://files.pythonhosted.org/packages/a8/7a/8d6fe30d424329ced46a738faaea4150efb8eee656599b88a791cf7ad07e/osfclient-0.0.5-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ea519e3668e8f6871fdd6aaf9c32890faea38c5b7cbc47e0c8283b05171c3f4a",
"md5": "ed3dc4ec2eb32ab10177fcb525a52904",
"sha256": "47c92bbdce57ecc0ed87eabe459025cc549080c48b28ebc86bfc5d82545a75c8"
},
"downloads": -1,
"filename": "osfclient-0.0.5.tar.gz",
"has_sig": false,
"md5_digest": "ed3dc4ec2eb32ab10177fcb525a52904",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 27366,
"upload_time": "2021-02-05T17:57:03",
"upload_time_iso_8601": "2021-02-05T17:57:03.399373Z",
"url": "https://files.pythonhosted.org/packages/ea/51/9e3668e8f6871fdd6aaf9c32890faea38c5b7cbc47e0c8283b05171c3f4a/osfclient-0.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2021-02-05 17:57:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "osfclient",
"github_project": "osfclient",
"travis_ci": true,
"coveralls": true,
"github_actions": false,
"requirements": [
{
"name": "requests",
"specs": []
},
{
"name": "tqdm",
"specs": []
},
{
"name": "six",
"specs": []
}
],
"lcname": "osfclient"
}
JSON
