# rgwadmin
[](https://rgwadmin.readthedocs.io/en/latest/?badge=latest)
rgwadmin is a Python library to access the Ceph Object Storage Admin API.
http://docs.ceph.com/docs/master/radosgw/adminops/
## API Example Usage
```python
from rgwadmin import RGWAdmin
rgw = RGWAdmin(access_key='XXX', secret_key='XXX', server='obj.example.com')
rgw.create_user(
uid='liam',
display_name='Liam Monahan',
email='liam@umiacs.umd.edu',
user_caps='usage=read, write; users=read',
max_buckets=1000)
rgw.set_user_quota(
uid='liam',
quota_type='user',
max_size_kb=1024*1024,
enabled=True)
rgw.remove_user(uid='liam', purge_data=True)
```
## User Example Usage
```python
from rgwadmin import RGWAdmin, RGWUser
RGWAdmin.connect(access_key='XXX', secret_key='XXX', server='obj.example.com')
u = RGWUser.create(user_id='test', display_name='Test User')
u.user_quota.size = 1024 * 1024 # in bytes
u.user_quota.enabled = True
u.save()
u.delete()
```
## Requirements
rgwadmin requires the following Python packages:
* [requests](http://python-requests.org/)
* [requests-aws4auth](https://github.com/tedder/requests-aws4auth)
Additionally, you need to have a [Ceph](http://www.ceph.org) Object Storage
instance with a user that has appropriate caps (capabilities) on the parts of
the API that you want to access. See the
[Ceph Object Storage](http://docs.ceph.com/docs/master/radosgw/) page for more
information.
Version 2.3.1 was the last to support Python 2. As of version 2.4.0 we support
using V4 signing for requests to the Ceph RGW Admin server only.
### Compatibility
rgwadmin implements all documented Admin API operations or recent versions of
Ceph. We also implement some of the undocumented ones, too...
## Installation
```pip install rgwadmin```
## License
rgwadmin - a Python interface to the Rados Gateway Admin API
Copyright (C) 2015 UMIACS
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Email:
github@umiacs.umd.edu
Raw data
{
"_id": null,
"home_page": "https://github.com/UMIACS/rgwadmin",
"name": "rgwadmin",
"maintainer": "UMIACS Staff",
"docs_url": null,
"requires_python": "",
"maintainer_email": "github@umiacs.umd.edu",
"keywords": "ceph,radosgw,admin api",
"author": "Derek Yarnell",
"author_email": "derek@umiacs.umd.edu",
"download_url": "https://files.pythonhosted.org/packages/93/2c/5c0673aec781e9b87bd9f9e661e9402589b007f1838daba879c954db4881/rgwadmin-2.4.5.tar.gz",
"platform": null,
"description": "# rgwadmin\n\n[](https://rgwadmin.readthedocs.io/en/latest/?badge=latest)\n\nrgwadmin is a Python library to access the Ceph Object Storage Admin API.\n\nhttp://docs.ceph.com/docs/master/radosgw/adminops/\n\n\n## API Example Usage\n\n```python\nfrom rgwadmin import RGWAdmin\n\nrgw = RGWAdmin(access_key='XXX', secret_key='XXX', server='obj.example.com')\nrgw.create_user(\n uid='liam',\n display_name='Liam Monahan',\n email='liam@umiacs.umd.edu',\n user_caps='usage=read, write; users=read',\n max_buckets=1000)\nrgw.set_user_quota(\n uid='liam',\n quota_type='user',\n max_size_kb=1024*1024,\n enabled=True)\nrgw.remove_user(uid='liam', purge_data=True)\n```\n\n## User Example Usage\n```python\nfrom rgwadmin import RGWAdmin, RGWUser\n\nRGWAdmin.connect(access_key='XXX', secret_key='XXX', server='obj.example.com')\nu = RGWUser.create(user_id='test', display_name='Test User')\nu.user_quota.size = 1024 * 1024 # in bytes\nu.user_quota.enabled = True\nu.save()\nu.delete()\n```\n\n## Requirements\n\nrgwadmin requires the following Python packages:\n\n * [requests](http://python-requests.org/)\n * [requests-aws4auth](https://github.com/tedder/requests-aws4auth)\n\nAdditionally, you need to have a [Ceph](http://www.ceph.org) Object Storage\ninstance with a user that has appropriate caps (capabilities) on the parts of\nthe API that you want to access. See the\n[Ceph Object Storage](http://docs.ceph.com/docs/master/radosgw/) page for more\ninformation.\n\nVersion 2.3.1 was the last to support Python 2. As of version 2.4.0 we support \nusing V4 signing for requests to the Ceph RGW Admin server only.\n\n### Compatibility\nrgwadmin implements all documented Admin API operations or recent versions of\nCeph. We also implement some of the undocumented ones, too...\n\n## Installation\n\n```pip install rgwadmin```\n\n\n## License\n\n rgwadmin - a Python interface to the Rados Gateway Admin API\n Copyright (C) 2015 UMIACS\n\n This library is free software; you can redistribute it and/or\n modify it under the terms of the GNU Lesser General Public\n License as published by the Free Software Foundation; either\n version 2.1 of the License, or (at your option) any later version.\n\n This library is distributed in the hope that it will be useful,\n but WITHOUT ANY WARRANTY; without even the implied warranty of\n MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n Lesser General Public License for more details.\n\n You should have received a copy of the GNU Lesser General Public\n License along with this library; if not, write to the Free Software\n Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA\n\n Email:\n github@umiacs.umd.edu\n",
"bugtrack_url": null,
"license": "LGPL v2.1",
"summary": "Python Rados Gateway Admin API",
"version": "2.4.5",
"project_urls": {
"Homepage": "https://github.com/UMIACS/rgwadmin"
},
"split_keywords": [
"ceph",
"radosgw",
"admin api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9d4e15804beb0bbc0aa290b19d9e25dbe6d50d2f730528539c8a40d327c30e68",
"md5": "55c25ab9294d827787c4fd205a90f3c8",
"sha256": "7e5328198a2163f6d486e3957cc967ab7dc2548848fcfb9c8fd99fa64ad5e262"
},
"downloads": -1,
"filename": "rgwadmin-2.4.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "55c25ab9294d827787c4fd205a90f3c8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 20975,
"upload_time": "2024-01-05T14:32:29",
"upload_time_iso_8601": "2024-01-05T14:32:29.921479Z",
"url": "https://files.pythonhosted.org/packages/9d/4e/15804beb0bbc0aa290b19d9e25dbe6d50d2f730528539c8a40d327c30e68/rgwadmin-2.4.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "932c5c0673aec781e9b87bd9f9e661e9402589b007f1838daba879c954db4881",
"md5": "c6e64c83871cc7024dae9ebb8773fd0d",
"sha256": "ae0c4e4345722516fca6f99e6bbe88597735d235d81449a240a0702874352b34"
},
"downloads": -1,
"filename": "rgwadmin-2.4.5.tar.gz",
"has_sig": false,
"md5_digest": "c6e64c83871cc7024dae9ebb8773fd0d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 30632,
"upload_time": "2024-01-05T14:32:31",
"upload_time_iso_8601": "2024-01-05T14:32:31.385023Z",
"url": "https://files.pythonhosted.org/packages/93/2c/5c0673aec781e9b87bd9f9e661e9402589b007f1838daba879c954db4881/rgwadmin-2.4.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-05 14:32:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "UMIACS",
"github_project": "rgwadmin",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"tox": true,
"lcname": "rgwadmin"
}
JSON
