# OnedataRESTFS
OnedataRESTFS is a [PyFilesystem](https://www.pyfilesystem.org/) interface to
[Onedata](https://onedata.org) virtual file system based on [Onedata REST API].
As a PyFilesystem concrete class, [OnedataRESTFS](https://github.com/onedata/onedatarestfs/)
allows you to work with Onedata in the same way as any other supported filesystem.
## Installing
You can install OnedataRESTFS from pip as follows:
```
pip install fs.onedatarestfs
```
## Opening a OnedataRESTFS
Open an OnedataRESTFS by explicitly using the constructor:
```python
from fs.onedatarestfs import OnedataRESTFS
onedata_onezone_host = "..."
onedata_access_token = "..."
odfs = OnedataRESTFS(onedata_onezone_host, onedata_access_token)
```
Or with a FS URL:
```python
from fs import open_fs
odfs = open_fs('onedatarestfs://HOST?token=...')
```
## Building and running tests
```bash
virtualenv -p /usr/bin/python3 venv
. venv/bin/activate
# Install tox
pip install coverage tox
# Run flake8 check
tox -c tox.ini -e flake8
# Run mypy typing check
tox -c tox.ini -e mypy
# Run PyFilesystem test suite
tox -c tox.ini -e fstest
```
## Documentation
- [PyFilesystem Wiki](https://www.pyfilesystem.org)
- [OnedataRESTFS Reference](http://onedatarestfs.readthedocs.io/en/latest/)
- [Onedata Homepage](https://onedata.org)
Raw data
{
"_id": null,
"home_page": "https://github.com/onedata/onedatarestfs",
"name": "fs.onedatarestfs",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "pyfilesystem, Onedata",
"author": "Bartek Kryza",
"author_email": "bkryza@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/38/72/9f572fcbaac593c05f433c6bcfa5df7eef29d2389d8ab7ec3c701754167f/fs.onedatarestfs-21.2.5.2.tar.gz",
"platform": null,
"description": "# OnedataRESTFS\n\nOnedataRESTFS is a [PyFilesystem](https://www.pyfilesystem.org/) interface to\n[Onedata](https://onedata.org) virtual file system based on [Onedata REST API].\n\nAs a PyFilesystem concrete class, [OnedataRESTFS](https://github.com/onedata/onedatarestfs/)\nallows you to work with Onedata in the same way as any other supported filesystem.\n\n## Installing\n\nYou can install OnedataRESTFS from pip as follows:\n\n```\npip install fs.onedatarestfs\n```\n\n## Opening a OnedataRESTFS\n\nOpen an OnedataRESTFS by explicitly using the constructor:\n\n```python\nfrom fs.onedatarestfs import OnedataRESTFS\nonedata_onezone_host = \"...\"\nonedata_access_token = \"...\"\nodfs = OnedataRESTFS(onedata_onezone_host, onedata_access_token)\n```\n\nOr with a FS URL:\n\n```python\n from fs import open_fs\n odfs = open_fs('onedatarestfs://HOST?token=...')\n```\n\n\n## Building and running tests\n\n```bash\nvirtualenv -p /usr/bin/python3 venv\n. venv/bin/activate\n\n# Install tox\npip install coverage tox\n\n# Run flake8 check\ntox -c tox.ini -e flake8\n\n# Run mypy typing check\ntox -c tox.ini -e mypy\n\n# Run PyFilesystem test suite\ntox -c tox.ini -e fstest\n```\n\n## Documentation\n\n- [PyFilesystem Wiki](https://www.pyfilesystem.org)\n- [OnedataRESTFS Reference](http://onedatarestfs.readthedocs.io/en/latest/)\n- [Onedata Homepage](https://onedata.org)",
"bugtrack_url": null,
"license": "MIT",
"summary": "Onedata REST-based filesystem for PyFilesystem",
"version": "21.2.5.2",
"project_urls": {
"Homepage": "https://github.com/onedata/onedatarestfs"
},
"split_keywords": [
"pyfilesystem",
" onedata"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "38729f572fcbaac593c05f433c6bcfa5df7eef29d2389d8ab7ec3c701754167f",
"md5": "768f2dc94e267201f2e8c39cdcbbcb0c",
"sha256": "73fe673a55cec644c07d51e25da79ba420aec2732224ee29ab2ebacaf80a7d79"
},
"downloads": -1,
"filename": "fs.onedatarestfs-21.2.5.2.tar.gz",
"has_sig": false,
"md5_digest": "768f2dc94e267201f2e8c39cdcbbcb0c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 19404,
"upload_time": "2024-06-27T11:53:41",
"upload_time_iso_8601": "2024-06-27T11:53:41.951189Z",
"url": "https://files.pythonhosted.org/packages/38/72/9f572fcbaac593c05f433c6bcfa5df7eef29d2389d8ab7ec3c701754167f/fs.onedatarestfs-21.2.5.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-27 11:53:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "onedata",
"github_project": "onedatarestfs",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "fs",
"specs": []
},
{
"name": "onedatafilerestclient",
"specs": [
[
"==",
"21.2.5.2"
]
]
}
],
"tox": true,
"lcname": "fs.onedatarestfs"
}
JSON
