Metadata-Version: 2.4
Name: nbdctools
Version: 1.0.1
Summary: Python version of NBDCtools, a collection of tools for handling datasets in the NBDC DataHub.
Keywords: abcd,nbdctools,dataset,data-analysis
Author: Le Zhang, Janosch Linkersdoerfer
Author-email: Le Zhang <dairc.service@gmail.com>, Janosch Linkersdoerfer <linkersdoerfer@gmail.com>
License-Expression: GPL-3.0-or-later
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering
Requires-Dist: polars>=1.39.3
Requires-Dist: rdata>=1.0.0
Requires-Dist: rds2py>=0.9.0
Requires-Dist: rpy2>=3.6.6
Requires-Python: >=3.11
Project-URL: Repository, https://github.com/nbdc-datahub/nbdctools-py
Project-URL: Documentation, https://software.nbdc-datahub.org/nbdctools-py/
Project-URL: Bug Tracker, https://github.com/nbdc-datahub/nbdctools-py/issues
Project-URL: Changelog, https://software.nbdc-datahub.org/nbdctools-py/changelog/
Description-Content-Type: text/markdown

# nbdctools

Python tooling for NIH NBDC Data Hub tabulated datasets, with two entry points:

- `create_dataset`: R-backed wrapper around `NBDCtools::create_dataset`
- `create_dataset_py`: pure-Python dataset assembly

## Documentation

For full installation, workflow guides, API reference, troubleshooting, and benchmarks,
use the documentation website:

- Main site: https://software.nbdc-datahub.org/nbdctools-py/
- R package: https://software.nbdc-datahub.org/NBDCtools/
  
## Requirements

- Python `>=3.11`

For the R-backed  (`create_dataset`):

- System R on `PATH`
- R packages `NBDCtools` and `NBDCtoolsData`

## Install

From PyPI:

```bash
pip install nbdctools
```

From source repo:

```bash
pip install "git+https://github.com/nbdc-datahub/nbdctools-py.git"
```

## License

GNU General Public License v3.0 or later (`GPL-3.0-or-later`).

