> For the complete documentation index, see [llms.txt](https://docs.thetransparencyproject.me/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.thetransparencyproject.me/readme.md).

# EthoPipe: ETL Pipeline for Applied Canine Ethology

Open-science ethological data ingestion pipeline for structured, reproducible behavioral data collection and validation.

## Overview

This project aims to support reproducible ethological research by validating, normalizing, and ingesting structured observational data through a deterministic Python-based pipeline.

## Features

* Pydantic-based schema validation
* FastAPI ingestion endpoints
* Testable Python package structure
* Open-source repository with reproducible setup

## Project status

Early rebuild / MVP

## Documentation and Specifications

We have extensive documentation, research papers, and architectural specifications available in the `docs/` directory:

* `docs/specifications/`: Technical and architectural specifications.
* `docs/research_papers/`: Research papers and ethogram definitions.
* `docs/whitepapers/`: Whitepapers and concept documents.
* `docs/misc/`: Additional resources.

## Installation

We recommend using a virtual environment.

```bash
python -m venv .venv
source .venv/bin/activate
pip install --upgrade pip
pip install -r requirements.txt
pip install -e .
```

## Contributing

We welcome contributions! Please refer to the `CONTRIBUTING.md` file for details on how to set up your environment, our code standards, and the pull request process.

## Repository structure

* `src/` - Application code
* `tests/` - Automated tests
* `docs/` - Project documentation, specifications, and papers
* `.github/workflows/` - CI/CD pipelines

## Acknowledgements

* [**GitBook**](https://www.gitbook.com/) for supporting this project by providing access to their community plan.

## Author

Alice Severi Gonçalves

ORCID: <https://orcid.org/0009-0003-0048-8982>

## License

This project is distributed under the terms of the LICENSE file.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.thetransparencyproject.me/readme.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
