| Name | Staff JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | Unofficial Python library to work with data on The StoryGraph. |
| upload_time | 2025-01-16 23:23:25 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | BSD 3-Clause License Copyright (c) 2024, Terrance All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
storygraph
reading
books
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Staff
Unofficial Python library to work with data on [The StoryGraph](https://thestorygraph.com).
_This library relies on interacting with The StoryGraph's website, and is liable to break at any moment! If you want something more stable, consider [voting for API support on the roadmap](https://roadmap.thestorygraph.com/features/posts/an-api)._
## Basic usage
Create a JSON file containing your login credentials for The StoryGraph, e.g. `.storygraph.json`:
```json
{
"email": "user@example.com",
"password": "password"
}
```
Create a client using your credentials file:
```python
from staff import StoryGraph
with StoryGraph(".storygraph.json") as sg:
latest = next(sg.current_books())
print(f"I'm reading {latest.title} by {latest.author}")
```
Your credentials file will be updated with a cookie from the website after your first sign-in.
Raw data
{
"_id": null,
"home_page": null,
"name": "Staff",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "storygraph, reading, books",
"author": null,
"author_email": "Terrance <pypi+staff@terrance.allofti.me>",
"download_url": "https://files.pythonhosted.org/packages/1f/ed/c34fe782552c66da93dd99156adbf2bca355c2e79e3289e5bdcd6f5b77db/staff-0.1.0.tar.gz",
"platform": null,
"description": "# Staff\n\nUnofficial Python library to work with data on [The StoryGraph](https://thestorygraph.com).\n\n_This library relies on interacting with The StoryGraph's website, and is liable to break at any moment! If you want something more stable, consider [voting for API support on the roadmap](https://roadmap.thestorygraph.com/features/posts/an-api)._\n\n## Basic usage\n\nCreate a JSON file containing your login credentials for The StoryGraph, e.g. `.storygraph.json`:\n\n```json\n{\n \"email\": \"user@example.com\",\n \"password\": \"password\"\n}\n```\n\nCreate a client using your credentials file:\n\n```python\nfrom staff import StoryGraph\n\nwith StoryGraph(\".storygraph.json\") as sg:\n latest = next(sg.current_books())\n print(f\"I'm reading {latest.title} by {latest.author}\")\n```\n\nYour credentials file will be updated with a cookie from the website after your first sign-in.\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License Copyright (c) 2024, Terrance All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ",
"summary": "Unofficial Python library to work with data on The StoryGraph.",
"version": "0.1.0",
"project_urls": {
"Source": "https://github.com/Terrance/Staff"
},
"split_keywords": [
"storygraph",
" reading",
" books"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1a4d4e7d7e1bf888a5b369ff4cee9704d4faa1a2a04e64c203c895f8ade3ba2b",
"md5": "a62e6d3e12a9825d50924e8ea4d4f1a0",
"sha256": "aa39ac872a42b4dc9f2b3d60aebf3dda207ce25d65f8473d6313e4df5cf1473e"
},
"downloads": -1,
"filename": "Staff-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a62e6d3e12a9825d50924e8ea4d4f1a0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 11554,
"upload_time": "2025-01-16T23:23:24",
"upload_time_iso_8601": "2025-01-16T23:23:24.253344Z",
"url": "https://files.pythonhosted.org/packages/1a/4d/4e7d7e1bf888a5b369ff4cee9704d4faa1a2a04e64c203c895f8ade3ba2b/Staff-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1fedc34fe782552c66da93dd99156adbf2bca355c2e79e3289e5bdcd6f5b77db",
"md5": "70f06d49f6bdfd8624daf40fea3dd9fe",
"sha256": "1f4ede63b4fac3b61bddcc3c9c5bedf27cd0e03dc22dea6a1c8381c5b8a4d36b"
},
"downloads": -1,
"filename": "staff-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "70f06d49f6bdfd8624daf40fea3dd9fe",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 9693,
"upload_time": "2025-01-16T23:23:25",
"upload_time_iso_8601": "2025-01-16T23:23:25.350933Z",
"url": "https://files.pythonhosted.org/packages/1f/ed/c34fe782552c66da93dd99156adbf2bca355c2e79e3289e5bdcd6f5b77db/staff-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-16 23:23:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Terrance",
"github_project": "Staff",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "staff"
}
