Metadata-Version: 2.1
Name: Staff
Version: 0.1.0
Summary: Unofficial Python library to work with data on The StoryGraph.
Author-email: Terrance <pypi+staff@terrance.allofti.me>
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.
        
Project-URL: Source, https://github.com/Terrance/Staff
Keywords: storygraph,reading,books
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Internet
Classifier: Topic :: Utilities
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: beautifulsoup4
Requires-Dist: requests

# 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.
