Metadata-Version: 2.4
Name: txttoqti
Version: 0.1.2
Summary: Universal converter that transforms text-based question banks into QTI packages compatible with Canvas LMS
Project-URL: Homepage, https://github.com/julihocc/txttoqti
Project-URL: Documentation, https://github.com/julihocc/txttoqti#readme
Project-URL: Repository, https://github.com/julihocc/txttoqti
Project-URL: Issues, https://github.com/julihocc/txttoqti/issues
Project-URL: Changelog, https://github.com/julihocc/txttoqti/releases
Author-email: "Juliho C.C." <julihocc@yahoo.com>
License: MIT
License-File: LICENSE
Keywords: assessment,canvas,education,lms,qti,quiz
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Education
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
Classifier: Topic :: Education
Classifier: Topic :: Text Processing :: Markup :: XML
Requires-Python: >=3.10
Provides-Extra: dev
Requires-Dist: black>=23.0; extra == 'dev'
Requires-Dist: flake8>=6.0; extra == 'dev'
Requires-Dist: mypy>=1.0; extra == 'dev'
Requires-Dist: pre-commit>=3.0; extra == 'dev'
Requires-Dist: pytest-cov>=4.0; extra == 'dev'
Requires-Dist: pytest>=7.0; extra == 'dev'
Provides-Extra: test
Requires-Dist: pytest-cov>=4.0; extra == 'test'
Requires-Dist: pytest>=7.0; extra == 'test'
Description-Content-Type: text/markdown

# txttoqti

txttoqti is a universal converter that transforms text-based question banks into QTI (Question & Test Interoperability) packages compatible with Canvas LMS and other learning management systems. This package is designed to simplify the process of creating QTI packages from plain text files, making it easier for educators and developers to manage and distribute assessments.

## Features

- Convert plain text to QTI packages
- Compatibility with Canvas LMS
- Smart conversion with change detection
- Comprehensive validation of question formats
- No external dependencies (uses only Python standard library)

## Installation

To install the txttoqti package, you can use pip. Clone the repository and run the following command:

```
pip install .
```

Alternatively, you can install it directly from PyPI (if available):

```
pip install txttoqti
```

## Usage

Here is a basic example of how to use the txttoqti package:

```python
from txttoqti import TxtToQtiConverter

converter = TxtToQtiConverter()
qti_file = converter.convert_file("questions.txt")
print(f"QTI package created: {qti_file}")
```

## Documentation

For detailed documentation, including API references and examples, please refer to the `docs` directory.

## Contributing

Contributions are welcome! Please feel free to submit a pull request or open an issue for any enhancements or bug fixes.

## License

This project is licensed under the MIT License. See the LICENSE file for more details.