Metadata-Version: 2.1
Name: problem_bank_scripts
Version: 0.11.1
Summary: A package with useful functions to convert between different problem bank formats.
Home-page: https://github.com/open-resources/problem_bank_scripts
License: MIT
Author: Open Problem Bank Team
Requires-Python: >=3.10,<3.13
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: PyYAML (>=6.0.1,<7.0.0)
Requires-Dist: black (>=24.4.2,<25.0.0)
Requires-Dist: docopt (>=0.6.2,<0.7.0)
Requires-Dist: exceptiongroup (>=1.2.1,<2.0.0) ; python_version < "3.11"
Requires-Dist: gitpython (>=3.1.43,<4.0.0)
Requires-Dist: markdown-it-py (>=2.2.0,<3.0.0)
Requires-Dist: mdformat (>=0.7.14,<0.8.0)
Requires-Dist: numpy (>=1.26.4,<2.0.0)
Requires-Dist: pandas (>=2.2.2,<3.0.0)
Requires-Dist: problem-bank-helpers (>=0.2.7,<0.3.0)
Requires-Dist: sympy (>=1.12.1,<2.0.0)
Requires-Dist: typing-extensions (>=4.12.2,<5.0.0)
Project-URL: Documentation, https://problem_bank_scripts.readthedocs.io/en/latest/
Project-URL: Repository, https://github.com/open-resources/problem_bank_scripts
Description-Content-Type: text/markdown

# Problem Bank Scripts 

[![Python](https://img.shields.io/badge/python-3.12-blue)]()
[![codecov](https://codecov.io/gh/open-resources/problem_bank_scripts/branch/main/graph/badge.svg)](https://codecov.io/gh/open-resources/problem_bank_scripts)
[![Documentation Status](https://readthedocs.org/projects/problem_bank_scripts/badge/?version=latest)](https://problem_bank_scripts.readthedocs.io/en/latest/?badge=latest)


## Installation

```bash
pip install problem_bank_scripts
```

## Update version

Here are the steps to increment the version (replace patch with major/minor/patch):

First, make sure to have the latest changes in the main branch.

```bash
git checkout main && git pull
```

Then, make sure all tests pass before incrementing the version.

```bash
poetry run pytest
```

Finally, increment the version and push the new tag and version change.

```bash
bash bump.sh patch

git push && git push --tags
```

To finalize the version update, create a new release on GitHub and the package will be automatically published
 to PyPI after the deployment is approved assuming all tests pass.

## Features

- TODO

## Dependencies

- TODO

## Usage

- TODO

## Documentation

The official documentation is hosted on Read the Docs: https://problem_bank_scripts.readthedocs.io/en/latest/

## Contributors

We welcome and recognize all contributions. You can see a list of current contributors in the [contributors tab](https://github.com/open-resources/problem_bank_scripts/graphs/contributors).

### Credits

This package was created with Cookiecutter and the UBC-MDS/cookiecutter-ubc-mds project template, modified from the [pyOpenSci/cookiecutter-pyopensci](https://github.com/pyOpenSci/cookiecutter-pyopensci) project template and the [audreyr/cookiecutter-pypackage](https://github.com/audreyr/cookiecutter-pypackage).

