Metadata-Version: 2.3
Name: mtbp3cd
Version: 0.1.48
Summary: my tool box for file management
License: GNU General Public License v3.0
Author: Y. Hsu
Requires-Python: >=3.10,<4.0
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Provides-Extra: docs
Requires-Dist: pandas (>=2.0.0,<3.0.0)
Requires-Dist: seaborn (>=0.13.2,<0.14.0)
Description-Content-Type: text/markdown

# mtbp3cd

![PyPI](https://img.shields.io/pypi/v/mtbp3cd?label=pypi%20package)
![PyPI - Downloads](https://img.shields.io/pypi/dm/mtbp3cd)
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)

My tool box built for managing files and contents.

Quick links: 
[Mtbp3cd Documentation](https://yh202109.github.io/mtbp3cd/index.html) |
[StatLab Documentation](https://yh202109.github.io/mtbp3Lab/index.html) |
[Github](https://github.com/yh202109/mtbp3cd) 

Functions are grouped into:

- File Inventory Tools <sup>[*]</sup>
  - gt01: folder snapshot, checksum, record comparison
  - gt02: column summary 
- Clinical Data Tools <sup>[*]</sup>
  - gt03: define.xml
  - gt04: subject
  - gt05: adverse event

<sup>[*]</sup> Documents are not executed while building.

## Table of Contents

- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license) 
- [Credits](#credits) 
- [How to Cite](#how-to-cite) 

## Installation

Instructions on how to install the project and its dependencies.

```bash
$ pip install mtbp3cd
```

## Usage

Below is an example of showing the version of currently installed package:

``` 
import mtbp3cd
print(mtbp3cd.__version__)
``` 

## Contributing

Interested in contributing? Check out the contributing guidelines. Please note that this project is released with a Code of Conduct. By contributing to this project, you agree to abide by its terms.

## License

`mtbp3cd` was created by Y. Hsu. It is licensed under the terms of the GNU General Public License v3.0 license.


## Credits

Documentation: 

- Documents were initially created with [`cookiecutter`](https://cookiecutter.readthedocs.io/en/latest/) and the `py-pkgs-cookiecutter` [template](https://github.com/py-pkgs/py-pkgs-cookiecutter).
- Version badges are provided by: https://img.shields.io/pypi
- Tests badges were generated by: https://smarie.github.io/python-genbadge/

Working Environment and Tools:

- Anaconda
- Github 
- Vim
- VSCode with Github Copilot


## How to Cite 

Hsu, Y. (2025). mtbp3cd: My tool box for managing files and contents. [Software]. Retrieved from https://yh202109.github.io/mtbp3/index.html.

```
@software{mtbp3,
  author = {Hsu, Y.},
  title = {mtbp3cd: My tool box built for managing files and contents},
  year = {2025},
  url = {https://yh202109.github.io/mtbp3cd/index.html},
  note = {Software}
}
```

