https://github.com/juliaaplavin/openscienceframework.jl
Julia interface for accessing and managing data from the Open Science Framework (OSF).
https://github.com/juliaaplavin/openscienceframework.jl
api-client data-access open-science-framework research-data
Last synced: 2 months ago
JSON representation
Julia interface for accessing and managing data from the Open Science Framework (OSF).
- Host: GitHub
- URL: https://github.com/juliaaplavin/openscienceframework.jl
- Owner: JuliaAPlavin
- License: mit
- Created: 2024-02-18T17:58:14.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-03-16T12:17:34.000Z (7 months ago)
- Last Synced: 2025-07-16T01:50:24.716Z (3 months ago)
- Topics: api-client, data-access, open-science-framework, research-data
- Language: Julia
- Homepage:
- Size: 47.9 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# OpenScienceFramework.jl
Interface to the The Open Science Framework ([OSF](https://osf.io/)) API.
# Usage
`OpenScienceFramework.jl` supports Julia Filesystem API:
```julia
import OpenScienceFramework as OSF
# public OSF projects:
proj = OSF.project(OSF.Client(), "")
readdir(proj)
read(readdir(proj)[1], String)
cp(readdir(proj)[1], "/some/local/path")
OSF.url(readdir(proj)[1])
# private OSF projects:
proj = OSF.project(OSF.Client(; token="your OSF token"); title="MyProject")
basename.(readdir(proj))
mkdir(joinpath(readdir(proj)[1], "newdir"))
cp("local_file", OSF.file(readdir(proj)[1], "remote_file"))
OSF.url(readdir(proj)[1])
```
There is also an internal module `OSF.API` with lower-level API functions. They are not covered by semver and may change arbitrarily.