Metadata-Version: 2.1
Name: behaverse
Version: 0.0.5.dev2
Summary: Behaverse Python Package.
Author-email: xCIT Development Team <contact@xcit.org>
Maintainer-email: Morteza Ansarinia <ansarinia@me.com>, Hoorieh Afkari <hoorieh.afkari@uni.lu>, Pedro Cardoso-Leite <pedro.cardosoleite@uni.lu>
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Classifier: Development Status :: 1 - Planning
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering
Requires-Dist: pandas
Requires-Dist: tqdm
Requires-Dist: requests
Requires-Dist: dvc>3 ; extra == "dvc"
Requires-Dist: dvc-ssh ; extra == "dvc"
Requires-Dist: pytest ; extra == "test"
Project-URL: Documentation, https://behaverse.github.io
Project-URL: Homepage, https://behaverse.org
Project-URL: Repository, https://github.com/behaverse/behaverse
Provides-Extra: dvc
Provides-Extra: test

# Behaverse Python Package

This package is a Python implementation of the Behaverse API. It allows you to interact with the Behaverse datasets in Python.

## Installation

To install the package, you can use pip:

```bash
pip install behaverse
```

## Usage

See the [documentation](https://behaverse.github.io/) for more information on how to use the package.



## Development

Before starting development, you need to install the dependencies:

```bash
mamba env create -f environment.yml
mamba activate behaverse
```

### Documentation

To generate documentations and API reference, run the following commands from the main directory of the project:

```bash
cd docs
quartodoc build && quartodoc interlinks && quarto preview
```

The documentation will be available in the `docs/_site/` directory.

## License

TODO

## Contributing

TODO

## Acknowledgements

TODO

## Citation

TODO

