Metadata-Version: 2.4
Name: estate
Version: 0.2.0
Summary: Official Rylse Engine SDK for Real Estate and PropTech.
Author-email: Rylse <hello@rylse.com>
License-Expression: MIT
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: requests>=2.25.1

# 🏢 Estate — Official Python SDK by Rylse

[![PyPI version](https://badge.fury.io/py/estate.svg)](https://badge.fury.io/py/estate)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)

**Estate** is the official Python SDK for interacting with the [Rylse Engine](https://rylse.com) PropTech and Real Estate API.

Instead of processing heavy geospatial data or managing vast property registries locally, the `estate` package offloads computational logic and data filtering directly to the **Rylse Edge Network** (`api.rylse.com`).

## ⚡ Installation

Install the package directly from PyPI:

```bash
pip install estate
```

## 🔑 Authentication

To connect to the Rylse Edge Network, authenticate your client using a Rylse API key.

* **Production Key:** Your dedicated `rylse_live_...` token.
* **Diagnostic Mode:** Use `rylse_test_ping` for network handshake and latency testing without accessing private workloads.

## 🚀 Quick Start

### Diagnostic Test

No production credentials are required for a basic connectivity test:

```python
import estate

client = estate.Client(api_key="rylse_test_ping")

status = client.ping()

print(status)
# Output:
# {
#     'status': 'connected',
#     'mode': 'diagnostic',
#     'latency_ms': 18.4,
#     ...
# }
```

### Production Workload

Use your production API key to access real estate workloads:

```python
import estate

client = estate.Client(
    api_key="rylse_live_YOUR_TOKEN"
)

result = client.properties.search(
    city="Warsaw",
    radius_km=10
)

print(result)
```

## 📚 Documentation

For complete API documentation, error handling, pipeline configuration, and advanced usage, visit:

[**Rylse Documentation — docs.rylse.com**](https://rylse.com)

## 📄 License

This project is licensed under the [MIT License](https://opensource.org/licenses/MIT).
