Metadata-Version: 2.4
Name: django-sb-codefield
Version: 0.5.0
Summary: Use codemirror2 widget directly in Django models, forms and admin.
Keywords: codefield,codemirror,django,dynova,softbutterfly
Author: Dynova Development Team, zodiacfireworks
Author-email: Dynova Development Team <dev@dynova.io>, zodiacfireworks <martin.vuelta@gmail.com>
License-Expression: Apache-2.0
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Framework :: Django :: 4
Classifier: Framework :: Django :: 5
Classifier: Framework :: Django :: 6
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: django>=4.2
Requires-Dist: django-codemirror2>=0.2
Maintainer: zodiacfireworks
Maintainer-email: zodiacfireworks <martin.vuelta@gmail.com>
Requires-Python: >=3.11.0, <4.0.0
Project-URL: Bug Tracker, https://gitlab.com/softbutterfly/open-source/django-sb-codefield/-/issues
Project-URL: Changelog, https://gitlab.com/softbutterfly/open-source/django-sb-codefield/-/blob/v0.5.0/CHANGELOG.md
Project-URL: Documentation, https://softbutterfly.gitlab.io/open-source/django-sb-codefield
Project-URL: Download, https://gitlab.com/softbutterfly/open-source/django-sb-codefield/-/archive/v0.5.0/django-sb-codefield-v0.5.0.tar.gz
Project-URL: Homepage, https://gitlab.com/softbutterfly/open-source/django-sb-codefield
Project-URL: Issues, https://gitlab.com/softbutterfly/open-source/django-sb-codefield/-/issues
Project-URL: Repository, https://gitlab.com/softbutterfly/open-source/django-sb-codefield
Description-Content-Type: text/markdown

# Django CodeField

**Django model field for Code using CodeMirror2.**

![Community-Project][repository:banner]

![PyPI - Supported versions][pypi:badge:python]
![PyPI - Package version][pypi:badge:version]
![PyPI - Downloads][pypi:badge:downloads]
![PyPI - License][pypi:badge:license]
[![Codacy Grade Badge][codacy:grade]][codacy:dashboard]
[![Codacy Coverage Badge][codacy:coverage]][codacy:dashboard]
[![Gitlab Pipeline Status][repository:pipeline]][repository:commits]

**django-sb-codefield** provide a django model field for Code using CodeMirror2.

## ✨ Features

- django model field for Code using CodeMirror2

## 📋 Requirements

- Python 3.11 or higher
- Django 4.2 or higher
- django-codemirror2 lower than 1.0.0

## 📦 Installation

### Using pip

```bash
pip install django-sb-codefield
```

### Using uv

```bash
uv add django-sb-codefield
```

## 🚀 Usage

Add `codemirror2` and `django_sb_codefield` to your `INSTALLED_APPS` settings

```python
INSTALLED_APPS = [
  # ...
  "codemirror2",
  "django_sb_codefield",
]
```

For more detailed instructions, see our [Step-by-Step Tutorial](./docs/tutorial.md).

## 🛠️ Development

Check out our [Contribution Guide](./CONTRIBUTING.md) for details on setting up
your development environment, running tests, and submitting pull requests.

The project uses `uv` for dependency management, `ruff` for linting, and `tox`
for multi-environment testing.

## 📜 Changelog

See the [CHANGELOG.md](./CHANGELOG.md) for a history of changes.

## 👥 Contributors

See our [list of contributors][repository:contributors].

## 📄 License

This project is licensed under the Apache License 2.0. See the
[LICENSE](./LICENSE) file for details.

[repository:banner]: https://gitlab.com/softbutterfly/open-source/open-source-office/-/raw/master/assets/dynova/dynova-open-source--banner--community-project.png

[repository:pipeline]: https://gitlab.com/softbutterfly/open-source/django-sb-codefield/badges/master/pipeline.svg
[repository:commits]: https://gitlab.com/softbutterfly/open-source/django-sb-codefield/-/commits/master
[repository:contributors]: https://gitlab.com/softbutterfly/open-source/django-sb-codefield/-/graphs/develop

[pypi:badge:python]: https://img.shields.io/pypi/pyversions/django-sb-codefield
[pypi:badge:version]: https://img.shields.io/pypi/v/django-sb-codefield
[pypi:badge:downloads]: https://img.shields.io/pypi/dm/django-sb-codefield
[pypi:badge:license]: https://img.shields.io/pypi/l/django-sb-codefield

[codacy:grade]: https://app.codacy.com/project/badge/Grade/fe5644bd3a114473879a304321a68f3e
[codacy:coverage]: https://app.codacy.com/project/badge/Coverage/fe5644bd3a114473879a304321a68f3e
[codacy:dashboard]: https://app.codacy.com/gl/softbutterfly/django-sb-codefield/dashboard
