Metadata-Version: 2.4
Name: ecointeract
Version: 0.1.3
Summary: A Python library for ecological data collection and environmental analysis
Author: Ane Simões
Author-email: anes.2017@alunos.utfpr.edu.br
License: MIT
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: ee
Requires-Dist: pandas
Requires-Dist: requests
Requires-Dist: networkx
Requires-Dist: duckdb
Dynamic: author
Dynamic: author-email
Dynamic: description
Dynamic: description-content-type
Dynamic: license
Dynamic: license-file
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# Usage

## Installation

```bash
pip install EcoInteract
```

## Quick Start

The main function exposed by this library is `get_interaction_data`, available in the `getgraph` module.

### get_interaction_data

Builds the interaction graph for a target species.

**Signature:**

```python
get_interaction_data(
    target_species: str,
    search_depth: int = 3,
    interaction_type: str | list[str] | None = None,
) -> nx.DiGraph | None
```

**Example:**

```python
from EcoInteract import get_interaction_data

# Fetch interaction data for a species
data = get_interaction_data(target_species="wolf")

# With custom depth and interaction types
data = get_interaction_data(
    target_species="wolf",
    search_depth=5,
    interaction_type=["predation", "competition"]
)
```

**Parameters:**
- `target_species` (str): The species to search interactions for
- `search_depth` (int): Depth of the interaction graph traversal (default: 3)
- `interaction_type` (str | list[str] | None): Filter by interaction type(s). If None, returns all interactions

**Returns:**
- A directed graph (`nx.DiGraph`) containing ecological relationships, or None if no interactions are found

## Documentation

For more information, refer to the module docstrings and source code.
