| Name | objectstore-client JSON |
| Version |
0.0.5
JSON |
| download |
| home_page | None |
| Summary | Client SDK for Objectstore, the Sentry object storage platform |
| upload_time | 2025-11-04 08:30:34 |
| maintainer | None |
| docs_url | None |
| author | Sentry |
| requires_python | >=3.11 |
| license | # Functional Source License, Version 1.1, Apache 2.0 Future License
## Abbreviation
FSL-1.1-Apache-2.0
## Notice
Copyright 2018-2024 Functional Software, Inc. dba Sentry
## Terms and Conditions
### Licensor ("We")
The party offering the Software under these Terms and Conditions.
### The Software
The "Software" is each version of the software that we make available under
these Terms and Conditions, as indicated by our inclusion of these Terms and
Conditions with the Software.
### License Grant
Subject to your compliance with this License Grant and the Patents,
Redistribution and Trademark clauses below, we hereby grant you the right to
use, copy, modify, create derivative works, publicly perform, publicly display
and redistribute the Software for any Permitted Purpose identified below.
### Permitted Purpose
A Permitted Purpose is any purpose other than a Competing Use. A Competing Use
means making the Software available to others in a commercial product or
service that:
1. substitutes for the Software;
2. substitutes for any other product or service we offer using the Software
that exists as of the date we make the Software available; or
3. offers the same or substantially similar functionality as the Software.
Permitted Purposes specifically include using the Software:
1. for your internal use and access;
2. for non-commercial education;
3. for non-commercial research; and
4. in connection with professional services that you provide to a licensee
using the Software in accordance with these Terms and Conditions.
### Patents
To the extent your use for a Permitted Purpose would necessarily infringe our
patents, the license grant above includes a license under our patents. If you
make a claim against any party that the Software infringes or contributes to
the infringement of any patent, then your patent license to the Software ends
immediately.
### Redistribution
The Terms and Conditions apply to all copies, modifications and derivatives of
the Software.
If you redistribute any copies, modifications or derivatives of the Software,
you must include a copy of or a link to these Terms and Conditions and not
remove any copyright notices provided in or with the Software.
### Disclaimer
THE SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTIES OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING WITHOUT LIMITATION WARRANTIES OF FITNESS FOR A PARTICULAR
PURPOSE, MERCHANTABILITY, TITLE OR NON-INFRINGEMENT.
IN NO EVENT WILL WE HAVE ANY LIABILITY TO YOU ARISING OUT OF OR RELATED TO THE
SOFTWARE, INCLUDING INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES,
EVEN IF WE HAVE BEEN INFORMED OF THEIR POSSIBILITY IN ADVANCE.
### Trademarks
Except for displaying the License Details and identifying us as the origin of
the Software, you have no right under these Terms and Conditions to use our
trademarks, trade names, service marks or product names.
## Grant of Future License
We hereby irrevocably grant you an additional license to use the Software under
the Apache License, Version 2.0 that is effective on the second anniversary of
the date we make the Software available. On or after that date, you may use the
Software under the Apache License, Version 2.0, in which case the following
will apply:
Licensed under the Apache License, Version 2.0 (the "License"); you may not use
this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed
under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
CONDITIONS OF ANY KIND, either express or implied. See the License for the
specific language governing permissions and limitations under the License. |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Objectstore Client
The client is used to interface with the objectstore backend. It handles
responsibilities like transparent compression, and making sure that uploads and
downloads are done as efficiently as possible.
## Usage
```python
import datetime
from objectstore_client import ClientBuilder, NoOpMetricsBackend, TimeToLive
client_builder = ClientBuilder(
"http://localhost:8888",
"my_usecase",
metrics_backend=NoOpMetricsBackend(), # optionally, provide your own MetricsBackend implementation
)
client = client_builder.for_project(42, 424242)
object_id = client.put(
b"Hello, world!",
metadata={"key": "value"},
expiration_policy=TimeToLive(datetime.timedelta(days=1)),
)
result = client.get(object_id)
content = result.payload.read()
assert content == b"Hello, world!"
assert result.metadata.custom["key"] == "value"
client.delete(object_id)
```
## Development
### Environment Setup
The considerations for setting up the development environment that can be found in the main [README](../README.md) apply for this package as well.
### Pre-commit hook
A configuration to set up a git pre-commit hook using [pre-commit](https://github.com/pre-commit/pre-commit) is available at the root of the repository.
To install it, run
```sh
pre-commit install
```
The hook will automatically run some checks before every commit, including the linters and formatters we run in CI.
Raw data
{
"_id": null,
"home_page": null,
"name": "objectstore-client",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": null,
"author": "Sentry",
"author_email": "Sentry <oss@sentry.io>",
"download_url": "https://files.pythonhosted.org/packages/b9/82/a5e4a0d120fb0ff6ab9aa97774f623b467465617e39cfc46c06f7340f064/objectstore_client-0.0.5.tar.gz",
"platform": null,
"description": "# Objectstore Client\n\nThe client is used to interface with the objectstore backend. It handles\nresponsibilities like transparent compression, and making sure that uploads and\ndownloads are done as efficiently as possible.\n\n## Usage\n\n```python\nimport datetime\n\nfrom objectstore_client import ClientBuilder, NoOpMetricsBackend, TimeToLive\n\nclient_builder = ClientBuilder(\n \"http://localhost:8888\",\n \"my_usecase\",\n metrics_backend=NoOpMetricsBackend(), # optionally, provide your own MetricsBackend implementation\n)\nclient = client_builder.for_project(42, 424242)\n\nobject_id = client.put(\n b\"Hello, world!\",\n metadata={\"key\": \"value\"},\n expiration_policy=TimeToLive(datetime.timedelta(days=1)),\n)\n\nresult = client.get(object_id)\n\ncontent = result.payload.read()\nassert content == b\"Hello, world!\"\nassert result.metadata.custom[\"key\"] == \"value\"\n\nclient.delete(object_id)\n```\n\n## Development\n\n### Environment Setup\n\nThe considerations for setting up the development environment that can be found in the main [README](../README.md) apply for this package as well.\n\n### Pre-commit hook\n\nA configuration to set up a git pre-commit hook using [pre-commit](https://github.com/pre-commit/pre-commit) is available at the root of the repository.\n\nTo install it, run\n```sh\npre-commit install\n```\n\nThe hook will automatically run some checks before every commit, including the linters and formatters we run in CI.\n",
"bugtrack_url": null,
"license": "# Functional Source License, Version 1.1, Apache 2.0 Future License\n \n ## Abbreviation\n \n FSL-1.1-Apache-2.0\n \n ## Notice\n \n Copyright 2018-2024 Functional Software, Inc. dba Sentry\n \n ## Terms and Conditions\n \n ### Licensor (\"We\")\n \n The party offering the Software under these Terms and Conditions.\n \n ### The Software\n \n The \"Software\" is each version of the software that we make available under\n these Terms and Conditions, as indicated by our inclusion of these Terms and\n Conditions with the Software.\n \n ### License Grant\n \n Subject to your compliance with this License Grant and the Patents,\n Redistribution and Trademark clauses below, we hereby grant you the right to\n use, copy, modify, create derivative works, publicly perform, publicly display\n and redistribute the Software for any Permitted Purpose identified below.\n \n ### Permitted Purpose\n \n A Permitted Purpose is any purpose other than a Competing Use. A Competing Use\n means making the Software available to others in a commercial product or\n service that:\n \n 1. substitutes for the Software;\n \n 2. substitutes for any other product or service we offer using the Software\n that exists as of the date we make the Software available; or\n \n 3. offers the same or substantially similar functionality as the Software.\n \n Permitted Purposes specifically include using the Software:\n \n 1. for your internal use and access;\n \n 2. for non-commercial education;\n \n 3. for non-commercial research; and\n \n 4. in connection with professional services that you provide to a licensee\n using the Software in accordance with these Terms and Conditions.\n \n ### Patents\n \n To the extent your use for a Permitted Purpose would necessarily infringe our\n patents, the license grant above includes a license under our patents. If you\n make a claim against any party that the Software infringes or contributes to\n the infringement of any patent, then your patent license to the Software ends\n immediately.\n \n ### Redistribution\n \n The Terms and Conditions apply to all copies, modifications and derivatives of\n the Software.\n \n If you redistribute any copies, modifications or derivatives of the Software,\n you must include a copy of or a link to these Terms and Conditions and not\n remove any copyright notices provided in or with the Software.\n \n ### Disclaimer\n \n THE SOFTWARE IS PROVIDED \"AS IS\" AND WITHOUT WARRANTIES OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING WITHOUT LIMITATION WARRANTIES OF FITNESS FOR A PARTICULAR\n PURPOSE, MERCHANTABILITY, TITLE OR NON-INFRINGEMENT.\n \n IN NO EVENT WILL WE HAVE ANY LIABILITY TO YOU ARISING OUT OF OR RELATED TO THE\n SOFTWARE, INCLUDING INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES,\n EVEN IF WE HAVE BEEN INFORMED OF THEIR POSSIBILITY IN ADVANCE.\n \n ### Trademarks\n \n Except for displaying the License Details and identifying us as the origin of\n the Software, you have no right under these Terms and Conditions to use our\n trademarks, trade names, service marks or product names.\n \n ## Grant of Future License\n \n We hereby irrevocably grant you an additional license to use the Software under\n the Apache License, Version 2.0 that is effective on the second anniversary of\n the date we make the Software available. On or after that date, you may use the\n Software under the Apache License, Version 2.0, in which case the following\n will apply:\n \n Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use\n this file except in compliance with the License.\n \n You may obtain a copy of the License at\n \n http://www.apache.org/licenses/LICENSE-2.0\n \n Unless required by applicable law or agreed to in writing, software distributed\n under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR\n CONDITIONS OF ANY KIND, either express or implied. See the License for the\n specific language governing permissions and limitations under the License.",
"summary": "Client SDK for Objectstore, the Sentry object storage platform",
"version": "0.0.5",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "076bbc747369149087fa0a1444cf4b5e606419bea969bf81c96123a12a02cf71",
"md5": "e4e10ca10fb0ce42f55136ea952ecd43",
"sha256": "80f069d48b325f0420f7bfc3cbddca3fa86012761ff462e0145664e3a206e907"
},
"downloads": -1,
"filename": "objectstore_client-0.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e4e10ca10fb0ce42f55136ea952ecd43",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 10155,
"upload_time": "2025-11-04T08:30:34",
"upload_time_iso_8601": "2025-11-04T08:30:34.155586Z",
"url": "https://files.pythonhosted.org/packages/07/6b/bc747369149087fa0a1444cf4b5e606419bea969bf81c96123a12a02cf71/objectstore_client-0.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "b982a5e4a0d120fb0ff6ab9aa97774f623b467465617e39cfc46c06f7340f064",
"md5": "354b470a2b027aefa4d2b5357078d01b",
"sha256": "e31d71641cef7c7dd9ac6320ef0309bf0a924bcd41eb4dd47851f50cb0288fe7"
},
"downloads": -1,
"filename": "objectstore_client-0.0.5.tar.gz",
"has_sig": false,
"md5_digest": "354b470a2b027aefa4d2b5357078d01b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 8472,
"upload_time": "2025-11-04T08:30:34",
"upload_time_iso_8601": "2025-11-04T08:30:34.888294Z",
"url": "https://files.pythonhosted.org/packages/b9/82/a5e4a0d120fb0ff6ab9aa97774f623b467465617e39cfc46c06f7340f064/objectstore_client-0.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-11-04 08:30:34",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "objectstore-client"
}
