Metadata-Version: 2.4
Name: scholarmis-framework
Version: 1.0.0
Summary: Scholarmis Framework
Project-URL: Homepage, https://github.com/scholarmis/scholarmis-framework
Author-email: Brian Simpokolwe <briansimpokolwe@gmail.com>
License-File: LICENSE
Keywords: framework,scholarmis-framework
Classifier: Framework :: Django
Classifier: Framework :: Django :: 5.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.12
Requires-Dist: asgiref>=3.8.1
Requires-Dist: celery>=5.4.0
Requires-Dist: channels-redis>=4.2.0
Requires-Dist: channels>=4.1.0
Requires-Dist: django-filter>=24.3
Requires-Dist: django-import-export>=4.2.1
Requires-Dist: django-model-utils>=4.5.1
Requires-Dist: django-notifications-hq>=1.8.3
Requires-Dist: django-renderpdf>=4.0.0
Requires-Dist: django-tables2>=2.7.0
Requires-Dist: django-tenants>=3.7.0
Requires-Dist: django<6.0.0,>=5.0.0
Requires-Dist: djangorestframework>=3.15.2
Requires-Dist: openpyxl>=3.1.5
Requires-Dist: premailer>=3.10.0
Requires-Dist: psycopg[binary]>=3.1.18
Requires-Dist: python-slugify>=8.0.4
Requires-Dist: semver>=3.0.2
Requires-Dist: tablib[all]>=3.7.0
Description-Content-Type: text/markdown

# Scholarmis Framework

**Scholarmis Framework** is the **core Python/Django package** for Scholarmis, providing **shared utilities, base classes, and common components** used across all modules of the Scholarmis ecosystem.

It is designed to **reduce code duplication**, enforce **consistent patterns**, and serve as the foundation for modular educational management apps.

---


## Installation

```bash
pip install scholarmis-framework
```

---

## Usage

Once installed, you can import and use the shared components in any module:

```python
from scholarmis.framework.db.models import BaseModel
```

* **BaseModel** – A reusable abstract Django model with common fields.
* **CLI** – Reuse core commands in module management scripts.

> The framework does not run standalone; it is meant to be imported by Scholarmis modules.

---

## Contributing

We welcome contributions!

1. Fork the repository
2. Create a feature branch
3. Submit a pull request

See [CONTRIBUTING.md](CONTRIBUTING.md) for more details.

---

## License

Scholarmis Framework is licensed under the **MIT License** – see [LICENSE](LICENSE).

---
