# OSF Project Exporter
This is a CLI tool for exporting research project data and files from the [OSF website](https://osf.io/). This is to prototype tool to export projects from the OSF website to a PDF, allowing users to back up, share or document their OSF projects in an offline medium.
## Development Setup
### Virtual Environment
1. Clone this repository onto your local machine.
2. Create a virtual environment to install dependencies. For `virtualenv` this is done with ``virtualenv <myenvname>``. Make sure your virtual environment is setup to use Python 3.12 or above (e.g., ``virtualenv <myenvname> --python="/usr/bin/python3.12"`` on Linux.)
3. From local Git repo: Activate your virtual environment and run ``pip install -e osfexport`` to install this repository as a modifiable package. Then install other requirements separately via `pip install -r requirements.txt`.
4. On the OSF website, create or log in to your account. Set up a personal access token (PAT) by going into your account settings, select `Personal access tokens` in the left side menu, and clicking `Create token`. You should give the token a name that helps you remember why you made it, like "PDF export", and choose the `osf.full_read` scope - this allows this token to read all public and private projects on your account. You can delete this token once you have finished exporting your projects.
## Installation
### From PyPI: releases 0.1.4 and onwards
Activate your virtual environment: for example, using `virtualenv` this is done by:
- `source <myenvname>/bin/activate` on Linux
- `<myenvname>\Scripts\activate` on Windows/Mac
Next, run `python -m pip install osfexport`. This will download and install this package and other dependencies from the PyPI index.
## Usage
- Run `osfexport` to get a list of basic commands you can use.
- To see what a command needs as input, type `--help` after the command name (e.g. `osfexport welcome --help`; `osfexport --help`)
- To export all your projects from the OSF into a PDF, run `osfexport projects`.
Raw data
{
"_id": null,
"home_page": null,
"name": "osfexport",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "OSF, osf, backup, Open Science Framework, export, Centre for Open Science, COS, open science, archive",
"author": null,
"author_email": "Benito Matischen <benito.matischen@manchester.ac.uk>, Ramiro Bravo <ramiro.bravo@manchester.ac.uk>, Sarah Jaffa <sarah.jaffa@manchester.ac.uk>, Center for Open Science <contact@cos.io>",
"download_url": "https://files.pythonhosted.org/packages/80/d3/7ff1bacca25b97fe84f97676601b035a788b0902a7a986788c7efd4941d6/osfexport-1.0.0.tar.gz",
"platform": null,
"description": "# OSF Project Exporter\n\nThis is a CLI tool for exporting research project data and files from the [OSF website](https://osf.io/). This is to prototype tool to export projects from the OSF website to a PDF, allowing users to back up, share or document their OSF projects in an offline medium.\n\n## Development Setup\n\n### Virtual Environment\n\n1. Clone this repository onto your local machine.\n2. Create a virtual environment to install dependencies. For `virtualenv` this is done with ``virtualenv <myenvname>``. Make sure your virtual environment is setup to use Python 3.12 or above (e.g., ``virtualenv <myenvname> --python=\"/usr/bin/python3.12\"`` on Linux.)\n3. From local Git repo: Activate your virtual environment and run ``pip install -e osfexport`` to install this repository as a modifiable package. Then install other requirements separately via `pip install -r requirements.txt`.\n4. On the OSF website, create or log in to your account. Set up a personal access token (PAT) by going into your account settings, select `Personal access tokens` in the left side menu, and clicking `Create token`. You should give the token a name that helps you remember why you made it, like \"PDF export\", and choose the `osf.full_read` scope - this allows this token to read all public and private projects on your account. You can delete this token once you have finished exporting your projects.\n\n## Installation\n\n### From PyPI: releases 0.1.4 and onwards\n\nActivate your virtual environment: for example, using `virtualenv` this is done by:\n\n- `source <myenvname>/bin/activate` on Linux\n- `<myenvname>\\Scripts\\activate` on Windows/Mac\n\nNext, run `python -m pip install osfexport`. This will download and install this package and other dependencies from the PyPI index.\n\n## Usage\n\n- Run `osfexport` to get a list of basic commands you can use.\n- To see what a command needs as input, type `--help` after the command name (e.g. `osfexport welcome --help`; `osfexport --help`)\n- To export all your projects from the OSF into a PDF, run `osfexport projects`.\n\n",
"bugtrack_url": null,
"license": null,
"summary": "A package for exporting projects from the Open Science Framework web app. Comes with a command-line interface for exporting projects.",
"version": "1.0.0",
"project_urls": {
"Issues": "https://github.com/CenterForOpenScience/osf-project-exporter/issues",
"ReleaseNotes": "https://github.com/CenterForOpenScience/osf-project-exporter/releases",
"Repository": "https://github.com/CenterForOpenScience/osf-project-exporter/tree/development"
},
"split_keywords": [
"osf",
" osf",
" backup",
" open science framework",
" export",
" centre for open science",
" cos",
" open science",
" archive"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "98fcec40457adfd0b36b6e1b69ae0dc5d0276948d3fdc3e45d76e18562edc028",
"md5": "2af5d0a8eae8dc3a2dae0e6303b132ac",
"sha256": "ce6d5d41d97cd828941e5cfb39eeb42ea2c1bf999bca5aa0b02bf56c977aa525"
},
"downloads": -1,
"filename": "osfexport-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2af5d0a8eae8dc3a2dae0e6303b132ac",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 1363368,
"upload_time": "2025-09-04T16:45:55",
"upload_time_iso_8601": "2025-09-04T16:45:55.832985Z",
"url": "https://files.pythonhosted.org/packages/98/fc/ec40457adfd0b36b6e1b69ae0dc5d0276948d3fdc3e45d76e18562edc028/osfexport-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "80d37ff1bacca25b97fe84f97676601b035a788b0902a7a986788c7efd4941d6",
"md5": "99a3e603dc8c4469bcac800f24a87f62",
"sha256": "51b8e12da7c300c737912367843899612924f037bbf02fe2ef9ca010c4cb44e7"
},
"downloads": -1,
"filename": "osfexport-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "99a3e603dc8c4469bcac800f24a87f62",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 1352498,
"upload_time": "2025-09-04T16:45:57",
"upload_time_iso_8601": "2025-09-04T16:45:57.425751Z",
"url": "https://files.pythonhosted.org/packages/80/d3/7ff1bacca25b97fe84f97676601b035a788b0902a7a986788c7efd4941d6/osfexport-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-04 16:45:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "CenterForOpenScience",
"github_project": "osf-project-exporter",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "osfexport"
}
JSON
