Metadata-Version: 2.4
Name: preepiseizures_api_client
Version: 0.1.0
Summary: Short description.
Author-email: Ana Sofia Carmo <anascacais@gmail.com>
License: BSD 3-Clause License
        
        Copyright (c) 2025, Ana Sofia Carmo
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this
          list of conditions and the following disclaimer.
        
        2. 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.
        
        3. 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: Repository, https://github.com/anascacais/preepiseizures-api-client
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# preepiseizures-api-client

Python client for interacting with the [PreEpiSeizures API](https://github.com/anascacais/preepiseizures-api).

This client simplifies access to authorized endpoints for researchers working with seizure-related data.

---

## 🚀 Installation

Install from PyPI:

```bash
pip install preepiseizures-api-client
```

---

## 📦 Usage

```python
from preepiseizures_api_client.client import PreEpiSeizuresDBClient

client = PreEpiSeizuresDBClient(
    api_url="http://localhost:8000", # or your remote server URL
    username="myusername",
    password="mypassword"
)
```

---

## 🔐 Authentication

The client handles authentication automatically:

- Authenticates with the provided username and password
- Requests a bearer token from the API
- Uses the token to authorize future requests

---

## 📂 Examples

See the `examples/example_query.py` file for a complete usage example.

---

## 🧾 License

Distributed under the MIT License. See `LICENSE` for more information.

---

## 🙋‍♀️ Author

Created by Ana Sofia Carmo  
Email: anascacais@gmail.com  
GitHub: [@anascacais](https://github.com/anascacais)
