wagtail-custom-code-editor 0.0.1__tar.gz

wagtail_custom_code_editor-0.0.1/LICENSE

@@ -0,0 +1,17 @@
+MIT License
+Copyright (c) 2024 Amin Shazrin Bin Shaharrudean
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

wagtail_custom_code_editor-0.0.1/MANIFEST.in

@@ -0,0 +1,6 @@
+include LICENSE
+include README.md
+recursive-include wagtail_custom_code_editor *
+global-exclude __pycache__
+global-exclude *.py[co]
+recursive-exclude docs

wagtail_custom_code_editor-0.0.1/PKG-INFO

@@ -0,0 +1,134 @@
+Metadata-Version: 2.1
+Name: wagtail-custom-code-editor
+Version: 0.0.1
+Summary: An Ace Editor that works in Wagtail CMS
+Author-email: Amin Shazrin <aminshazrin@yahoo.com>
+License: MIT License
+        Copyright (c) 2024 Amin Shazrin Bin Shaharrudean
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+Project-URL: Homepage, https://github.com/ammein/wagtail-custom-code-editor
+Keywords: wagtail,cms,custom-code-editor,editor,code,acejs,wagtailcms,wagtail-cms,field,field-block
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 5.0
+Classifier: Framework :: Wagtail
+Classifier: Framework :: Wagtail :: 1
+Classifier: Framework :: Wagtail :: 2
+Classifier: Framework :: Wagtail :: 3
+Classifier: Framework :: Wagtail :: 4
+Classifier: Framework :: Wagtail :: 5
+Classifier: Framework :: Wagtail :: 6
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: django>=4.2
+Provides-Extra: testing
+Requires-Dist: django>=4.2; extra == "testing"
+Requires-Dist: wagtail>=6.2; extra == "testing"
+Provides-Extra: dynamic
+Requires-Dist: dependencies; extra == "dynamic"
+
+# wagtail-custom-code-editor
+![Wagtail Custom Code Editor Workflow](https://github.com/ammein/wagtail-custom-code-editor/actions/workflows/github-actions-check.yml/badge.svg)
+
+A **Wagtail Custom Code Editor Field** for your own editor field.
+
+This package adds a full-featured code editor that is perfect for coding tutorials, documentation containing code examples, or any other type of page that needs to display code.
+
+This field uses the open-source Ace Editor library that you may found here [Ace Editor](https://ace.c9.io/)
+
+![intro](https://raw.githubusercontent.com/ammein/wagtail-custom-code-editor/refs/heads/main/docs/intro.gif)
+
+## Features
+- Replace traditional textarea to Ace Editor that you can easily check the linting of the codes.
+- Add snippet for better re-usable small region of source code, or any text format.
+- Configure your own Ace Editor Options to your own editor preferences.
+- Easily change mode available on your own default/custom mode's setup.
+- You can save any code highlights so that it can retain the same highlight's code when you change to different mode.
+
+## Documentation
+- [Settings](https://github.com/ammein/wagtail-custom-code-editor/blob/main/docs/settings.md)
+- [Widget Options](https://github.com/ammein/wagtail-custom-code-editor/blob/main/docs/options.md)
+- [Change Modes](https://github.com/ammein/wagtail-custom-code-editor/blob/main/docs/modes.md)
+- [Django Admin](https://github.com/ammein/wagtail-custom-code-editor/blob/main/docs/django-admin.md)
+
+## Install
+
+In your settings, add the package in `INSTALLED_APPS`:
+```python
+INSTALLED_APPS = [
+    ...
+    "wagtail_custom_code_editor",
+    ...
+]
+```
+
+### Usage
+
+#### Field
+You can easily add the `CustomCodeEditorField` to your model fields like this:
+```python
+from wagtail_custom_code_editor.fields import CustomCodeEditorField
+
+class MyPage(Page):
+    code = CustomCodeEditorField()
+    ...
+```
+> The field is using [Django's JSONField](https://docs.djangoproject.com/en/5.1/ref/models/fields/#django.db.models.JSONField)
+
+#### Panel
+Then you add `CustomCodeEditorPanel` like this:
+
+```python
+from wagtail_custom_code_editor.panels import CustomCodeEditorPanel
+from wagtail_custom_code_editor.fields import CustomCodeEditorField
+
+class MyPage(Page):
+    code = CustomCodeEditorField()
+
+    content_panels = Page.content_panels + [
+        CustomCodeEditorPanel('code')
+    ]
+```
+
+#### Frontend
+You can easily grab the JSON value like this:
+```html
+<pre><code>{{ page.code.code }}</code></pre>
+```
+
+The JSON returns this two key value:
+```json
+{
+  "code": "Any Code here",
+  "mode": "html" 
+}
+```
+
+## License
+
+Wagtail-Geo-Widget is released under the [MIT License](http://www.opensource.org/licenses/MIT).

wagtail_custom_code_editor-0.0.1/README.md

@@ -0,0 +1,80 @@
+# wagtail-custom-code-editor
+![Wagtail Custom Code Editor Workflow](https://github.com/ammein/wagtail-custom-code-editor/actions/workflows/github-actions-check.yml/badge.svg)
+
+A **Wagtail Custom Code Editor Field** for your own editor field.
+
+This package adds a full-featured code editor that is perfect for coding tutorials, documentation containing code examples, or any other type of page that needs to display code.
+
+This field uses the open-source Ace Editor library that you may found here [Ace Editor](https://ace.c9.io/)
+
+![intro](https://raw.githubusercontent.com/ammein/wagtail-custom-code-editor/refs/heads/main/docs/intro.gif)
+
+## Features
+- Replace traditional textarea to Ace Editor that you can easily check the linting of the codes.
+- Add snippet for better re-usable small region of source code, or any text format.
+- Configure your own Ace Editor Options to your own editor preferences.
+- Easily change mode available on your own default/custom mode's setup.
+- You can save any code highlights so that it can retain the same highlight's code when you change to different mode.
+
+## Documentation
+- [Settings](https://github.com/ammein/wagtail-custom-code-editor/blob/main/docs/settings.md)
+- [Widget Options](https://github.com/ammein/wagtail-custom-code-editor/blob/main/docs/options.md)
+- [Change Modes](https://github.com/ammein/wagtail-custom-code-editor/blob/main/docs/modes.md)
+- [Django Admin](https://github.com/ammein/wagtail-custom-code-editor/blob/main/docs/django-admin.md)
+
+## Install
+
+In your settings, add the package in `INSTALLED_APPS`:
+```python
+INSTALLED_APPS = [
+    ...
+    "wagtail_custom_code_editor",
+    ...
+]
+```
+
+### Usage
+
+#### Field
+You can easily add the `CustomCodeEditorField` to your model fields like this:
+```python
+from wagtail_custom_code_editor.fields import CustomCodeEditorField
+
+class MyPage(Page):
+    code = CustomCodeEditorField()
+    ...
+```
+> The field is using [Django's JSONField](https://docs.djangoproject.com/en/5.1/ref/models/fields/#django.db.models.JSONField)
+
+#### Panel
+Then you add `CustomCodeEditorPanel` like this:
+
+```python
+from wagtail_custom_code_editor.panels import CustomCodeEditorPanel
+from wagtail_custom_code_editor.fields import CustomCodeEditorField
+
+class MyPage(Page):
+    code = CustomCodeEditorField()
+
+    content_panels = Page.content_panels + [
+        CustomCodeEditorPanel('code')
+    ]
+```
+
+#### Frontend
+You can easily grab the JSON value like this:
+```html
+<pre><code>{{ page.code.code }}</code></pre>
+```
+
+The JSON returns this two key value:
+```json
+{
+  "code": "Any Code here",
+  "mode": "html" 
+}
+```
+
+## License
+
+Wagtail-Geo-Widget is released under the [MIT License](http://www.opensource.org/licenses/MIT).

wagtail_custom_code_editor-0.0.1/pyproject.toml

@@ -0,0 +1,57 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "wagtail-custom-code-editor"
+version = "0.0.1"
+dependencies = [
+    "django>=4.2",  # Replace "X.Y" as appropriate
+]
+description = "An Ace Editor that works in Wagtail CMS"
+readme = "README.md"
+authors = [
+    {name = "Amin Shazrin", email = "aminshazrin@yahoo.com"},
+]
+keywords = [
+    "wagtail",
+    "cms",
+    "custom-code-editor",
+    "editor",
+    "code",
+    "acejs",
+    "wagtailcms",
+    "wagtail-cms",
+    "field",
+    "field-block",
+]
+classifiers = [
+    "Environment :: Web Environment",
+    "Framework :: Django",
+    "Framework :: Django :: 5.0",
+    "Framework :: Wagtail",
+    "Framework :: Wagtail :: 1",
+    "Framework :: Wagtail :: 2",
+    "Framework :: Wagtail :: 3",
+    "Framework :: Wagtail :: 4",
+    "Framework :: Wagtail :: 5",
+    "Framework :: Wagtail :: 6",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Internet :: WWW/HTTP",
+    "Topic :: Internet :: WWW/HTTP :: Dynamic Content",
+]
+license = {file = "LICENSE"}
+
+[project.optional-dependencies]
+dynamic = ['dependencies']
+
+[project.urls]
+Homepage = "https://github.com/ammein/wagtail-custom-code-editor"

wagtail_custom_code_editor-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

wagtail_custom_code_editor-0.0.1/setup.py

@@ -0,0 +1,20 @@
+import os
+from setuptools import setup
+
+with open(os.path.join(os.path.dirname(__file__), 'README.md')) as readme:
+    README = readme.read()
+
+# allow setup.py to be run from any path
+os.chdir(os.path.normpath(os.path.join(os.path.abspath(__file__), os.pardir)))
+
+testing_extras = [
+    # For test site
+    'django>=4.2',
+    'wagtail>=6.2',
+]
+
+setup(
+    extras_require={
+        'testing': testing_extras
+    },
+)

wagtail_custom_code_editor-0.0.1/wagtail_custom_code_editor/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class WagtailCustomCodeEditorConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = 'wagtail_custom_code_editor'

wagtail_custom_code_editor-0.0.1/wagtail_custom_code_editor/blocks.py

@@ -0,0 +1,52 @@
+from __future__ import annotations
+from django import forms
+from wagtail.blocks import FieldBlock
+from .validators import CustomCodeEditorDecoder
+from .widgets import CustomCodeEditorWidget
+
+
+class CustomCodeEditorBlock(FieldBlock):
+    def __init__(
+            self,
+            mode=None,
+            theme=None,
+            width="100%",
+            height="500px",
+            font_size=None,
+            keybinding=None,
+            useworker=True,
+            extensions=None,
+            enable_options=True,
+            enable_modes=False,
+            dropdown_config=None,
+            read_only_config=None,
+            save_command_config=None,
+            options=None,
+            modes=None,
+            attrs=None,
+            **kwargs,
+    ):
+        self._ace_options = {
+            "mode": mode,
+            "theme": theme,
+            "width": width,
+            "height": height,
+            "font_size": font_size,
+            "keybinding": keybinding,
+            "useworker": useworker,
+            "extensions": extensions,
+            "enable_options": enable_options,
+            "enable_modes": enable_modes,
+            "dropdown_config": dropdown_config,
+            "read_only_config": read_only_config,
+            "save_command_config": save_command_config,
+            "options": options,
+            "modes": modes,
+            "attrs": attrs,
+            "block": True
+        }
+        self.field = forms.JSONField(widget=CustomCodeEditorWidget(**self._ace_options), decoder=CustomCodeEditorDecoder, **kwargs)
+        super().__init__(**kwargs)
+
+    class Meta:
+        icon = 'code'

wagtail_custom_code_editor-0.0.1/wagtail_custom_code_editor/fields.py

@@ -0,0 +1,11 @@
+from django.db import models
+
+from .validators import CustomCodeEditorDecoder
+
+
+class CustomCodeEditorField(models.JSONField):
+    description = "Custom Code Editor"
+
+    def __init__(self, *args, **kwargs):
+        kwargs['decoder'] = CustomCodeEditorDecoder
+        super().__init__(*args, **kwargs)

wagtail_custom_code_editor-0.0.1/wagtail_custom_code_editor/files.py

@@ -0,0 +1,3 @@
+MODES = ['io.js', 'csound_document.js', 'html.js', 'rhtml.js', 'html_ruby.js', 'sh.js', 'cirru.js', 'jack.js', 'haml.js', 'vhdl.js', 'prolog.js', 'jsx.js', 'powershell.js', 'graphqlschema.js', 'c_cpp.js', 'liquid.js', 'perl.js', 'typescript.js', 'scrypt.js', 'verilog.js', 'smarty.js', 'gobstones.js', 'red.js', 'logiql.js', 'slim.js', 'visualforce.js', 'csp.js', 'dart.js', 'odin.js', 'd.js', 'sass.js', 'matlab.js', 'ruby.js', 'pgsql.js', 'fsharp.js', 'curly.js', 'livescript.js', 'xml.js', 'zeek.js', 'raku.js', 'crystal.js', 'apex.js', 'drools.js', 'plain_text.js', 'gherkin.js', 'mask.js', 'sparql.js', 'redshift.js', 'coldfusion.js', 'java.js', 'objectivec.js', 'glsl.js', 'lucene.js', 'applescript.js', 'ada.js', 'lua.js', 'django.js', 'ion.js', 'lisp.js', 'xquery.js', 'properties.js', 'c9search.js', 'soy_template.js', 'tsx.js', 'nasal.js', 'cobol.js', 'tex.js', 'html_elixir.js', 'haskell_cabal.js', 'mediawiki.js', 'r.js', 'smithy.js', 'ejs.js', 'mushcode.js', 'flix.js', 'nix.js', 'jade.js', 'handlebars.js', 'csound_score.js', 'erlang.js', 'mixal.js', 'sqlserver.js', 'ocaml.js', 'terraform.js', 'abap.js', 'fortran.js', 'elm.js', 'jssm.js', 'hjson.js', 'jsp.js', 'haskell.js', 'rdoc.js', 'latex.js', 'julia.js', 'jsoniq.js', 'logtalk.js', 'javascript.js', 'textile.js', 'latte.js', 'nsis.js', 'bibtex.js', 'qml.js', 'protobuf.js', 'fsl.js', 'dot.js', 'space.js', 'jexl.js', 'sjs.js', 'less.js', 'json5.js', 'coffee.js', 'praat.js', 'robot.js', 'asciidoc.js', 'razor.js', 'php.js', 'ini.js', 'sql.js', 'assembly_arm32.js', 'php_laravel_blade.js', 'ftl.js', 'mysql.js', 'toml.js', 'prisma.js', 'scala.js', 'rust.js', 'groovy.js', 'vue.js', 'abc.js', 'apache_conf.js', 'scad.js', 'batchfile.js', 'nunjucks.js', 'gcode.js', 'csound_orchestra.js', 'scheme.js', 'rst.js', 'autohotkey.js', 'haxe.js', 'clojure.js', 'zig.js', 'partiql.js', 'plsql.js', 'velocity.js', 'wollok.js', 'json.js', 'csharp.js', 'tcl.js', 'mips.js', 'prql.js', 'eiffel.js', 'stylus.js', 'maze.js', 'alda.js', 'svg.js', 'elixir.js', 'nginx.js', 'twig.js', 'lsl.js', 'nim.js', 'vbscript.js', 'forth.js', 'css.js', 'luapage.js', 'sac.js', 'yaml.js', 'gitignore.js', 'pascal.js', 'turtle.js', 'vala.js', 'astro.js', 'asl.js', 'kotlin.js', 'golang.js', 'diff.js', 'snippets.js', 'makefile.js', 'python.js', 'assembly_x86.js', 'edifact.js', 'dockerfile.js', 'text.js', 'cuttlefish.js', 'actionscript.js', 'swift.js', 'pig.js', 'puppet.js', 'markdown.js', 'scss.js', 'aql.js', 'mel.js']
+EXTENSIONS = ['ext-command_bar.js', 'ext-inline_autocomplete.js', 'ext-emmet.js', 'ext-textarea.js', 'ext-error_marker.js', 'ext-searchbox.js', 'ext-static_highlight.js', 'ext-code_lens.js', 'ext-spellcheck.js', 'ext-prompt.js', 'ext-hardwrap.js', 'ext-linking.js', 'ext-modelist.js', 'ext-beautify.js', 'ext-themelist.js', 'ext-language_tools.js', 'ext-statusbar.js', 'ext-elastic_tabstops_lite.js', 'ext-split.js', 'ext-options.js', 'ext-simple_tokenizer.js', 'ext-keybinding_menu.js', 'ext-rtl.js', 'ext-whitespace.js', 'ext-settings_menu.js']
+WORKERS = ['worker-css.js', 'worker-coffee.js', 'worker-javascript.js', 'worker-json.js', 'worker-base.js', 'worker-php.js', 'worker-yaml.js', 'worker-lua.js', 'worker-html.js', 'worker-xml.js', 'worker-xquery.js']

wagtail_custom_code_editor-0.0.1/wagtail_custom_code_editor/panels.py

@@ -0,0 +1,43 @@
+from wagtail.admin.panels import FieldPanel
+from .widgets import CustomCodeEditorWidget
+
+
+class CustomCodeEditorPanel(FieldPanel):
+    def __init__(
+            self,
+            field_name,
+            *args,
+            **kwargs
+    ):
+        self.ace_options = {
+            "mode": kwargs.pop('mode', 'html'),
+            "theme": kwargs.pop('theme', 'chrome'),
+            "width": kwargs.pop('width', "100%"),
+            "height": kwargs.pop('height', '300px'),
+            "font_size": kwargs.pop('font_size', None),
+            "keybinding": kwargs.pop('keybinding', None),
+            "useworker": kwargs.pop('useworker', None),
+            "extensions": kwargs.pop('extensions', None),
+            "enable_options": kwargs.pop('enable_options', True),
+            "enable_modes": kwargs.pop('enable_modes', False),
+            "dropdown_config": kwargs.pop('dropdown_config', None),
+            "read_only_config": kwargs.pop('read_only_config', None),
+            "save_command_config": kwargs.pop('save_command_config', None),
+            "options": kwargs.pop('options', None),
+            "modes": kwargs.pop('modes', None),
+            "attrs": kwargs.pop('attrs', None)
+        }
+        super().__init__(field_name, *args, **kwargs)
+
+    # To enable cloning with the same ace options attributes using class instance
+    def clone(self):
+        instance = super().clone()
+        instance.ace_options = self.ace_options
+        return instance
+
+    def get_form_options(self):
+        opts = super().get_form_options()
+        opts['widgets'] = {
+            self.field_name: CustomCodeEditorWidget(**self.ace_options)
+        }
+        return opts