{"id":15696017,"url":"https://github.com/mfcovington/django-markupfield-helpers","last_synced_at":"2026-05-03T02:44:21.277Z","repository":{"id":57420777,"uuid":"159976623","full_name":"mfcovington/django-markupfield-helpers","owner":"mfcovington","description":"A set of Django helpers that make it easier to get up and running quickly with django-markupfield","archived":false,"fork":false,"pushed_at":"2018-12-07T07:23:54.000Z","size":13,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"develop","last_synced_at":"2025-09-19T16:49:14.187Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mfcovington.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.rst","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-12-01T18:49:40.000Z","updated_at":"2018-12-07T07:23:55.000Z","dependencies_parsed_at":"2022-09-15T15:50:47.517Z","dependency_job_id":null,"html_url":"https://github.com/mfcovington/django-markupfield-helpers","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/mfcovington/django-markupfield-helpers","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mfcovington%2Fdjango-markupfield-helpers","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mfcovington%2Fdjango-markupfield-helpers/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mfcovington%2Fdjango-markupfield-helpers/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mfcovington%2Fdjango-markupfield-helpers/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mfcovington","download_url":"https://codeload.github.com/mfcovington/django-markupfield-helpers/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mfcovington%2Fdjango-markupfield-helpers/sbom","scorecard":{"id":638697,"data":{"date":"2025-08-11","repo":{"name":"github.com/mfcovington/django-markupfield-helpers","commit":"4e3486f8128aacaf42d1068a24a4a694089550c7"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.7,"checks":[{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":0,"reason":"Found 0/23 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: BSD 3-Clause \"New\" or \"Revised\" License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":0,"reason":"Project has not signed or included provenance with any releases.","details":["Warn: release artifact 0.1.1 not signed: https://api.github.com/repos/mfcovington/django-markupfield-helpers/releases/14299513","Warn: release artifact 0.1.0 not signed: https://api.github.com/repos/mfcovington/django-markupfield-helpers/releases/14299358","Warn: release artifact 0.1.1 does not have provenance: https://api.github.com/repos/mfcovington/django-markupfield-helpers/releases/14299513","Warn: release artifact 0.1.0 does not have provenance: https://api.github.com/repos/mfcovington/django-markupfield-helpers/releases/14299358"],"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'develop'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}}]},"last_synced_at":"2025-08-21T10:02:01.912Z","repository_id":57420777,"created_at":"2025-08-21T10:02:01.912Z","updated_at":"2025-08-21T10:02:01.912Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32556771,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-03T00:31:16.350Z","status":"online","status_checked_at":"2026-05-03T02:00:09.297Z","response_time":103,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-03T19:06:33.647Z","updated_at":"2026-05-03T02:44:21.261Z","avatar_url":"https://github.com/mfcovington.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"**************************\ndjango-markupfield-helpers\n**************************\n\n``django-markupfield-helpers`` is a set of Django helpers that make it easier to get up and running quickly with ``django-markupfield``.\n\nSource code is available on GitHub at `mfcovington/django-markupfield-helpers \u003chttps://github.com/mfcovington/django-markupfield-helpers\u003e`_. Information about ``django-markupfield`` is available on `GitHub \u003chttps://github.com/jamesturk/django-markupfield\u003e`_.\n\n\n.. contents:: :local:\n\n\nInstallation\n============\n\n**PyPI**\n\n.. code-block:: sh\n\n    pip install django-markupfield-helpers\n\n\n**GitHub (development branch)**\n\n.. code-block:: sh\n\n    pip install git+http://github.com/mfcovington/django-markupfield-helpers.git@develop\n\n\nConfiguration\n=============\n\nAdd ``markupfield_helpers`` to ``INSTALLED_APPS`` in ``settings.py``:\n\n.. code-block:: python\n\n    INSTALLED_APPS = (\n        ...\n        'markupfield_helpers',\n    )\n\n\nAdd a link to the CSS file for syntax highlighting in ``base.html`` or in a specific template.\n\n.. code-block:: python\n\n    {% load staticfiles %}\n\n    \u003clink rel=\"stylesheet\" type=\"text/css\" href=\"{% static 'markupfield_helpers/css/syntax-highlighting.css' %}\"\u003e\n\n\n``markupfield_helpers`` can be left out of ``INSTALLED_APPS`` if the provided CSS for syntax highlighting is not needed.\n\n\nHelpers\n=======\n\n``MarkupField``\n---------------\n\nThe ``MarkupField`` class from ``markupfield_helpers`` can be used in place of the class of the same name from ``markupfield``.\n\nThe ``markupfield_helpers`` version comes with four markup types defined:\n\n- ``Markdown`` (**Default**): Markdown 2 with extras (``code-friendly``, ``cuddled-lists``, ``fenced-code-blocks``, ``footnotes``, and ``tables``)\n- ``Markdown Basic``: Markdown 2 without extras\n- ``Plain Text``\n- ``reStructuredText``\n\n\nHere is a basic example of how to use the ``markupfield_helpers`` version of ``MarkupField``:\n\n.. code-block:: python\n\n    from django.db import models\n    from markupfield_helpers.helpers import MarkupField\n\n    class Article(models.Model):\n        title = models.CharField(max_length=100)\n        slug = models.SlugField(max_length=100)\n        body = MarkupField()\n\n\n``MARKUP_FIELD_TYPES``\n----------------------\n\nAlternatively, ``MARKUP_FIELD_TYPES`` can be imported from ``markupfield_helpers.helpers`` and used as-is or modified.\nThis is equivalent to the code above:\n\n\n.. code-block:: python\n\n    from django.db import models\n    from markupfield.fields import MarkupField\n    from markupfield_helpers.helpers import MARKUP_FIELD_TYPES\n\n\n    class Article(models.Model):\n        title = models.CharField(max_length=100)\n        slug = models.SlugField(max_length=100)\n        body = MarkupField(\n            default_markup_type='Markdown',\n            markup_choices=MARKUP_FIELD_TYPES,\n        )\n\n\nIssues\n======\n\nIf you experience any problems or would like to request a feature, please `create an issue \u003chttps://github.com/mfcovington/django-markupfield-helpers/issues\u003e`_ on GitHub.\n\n\n*Version 0.1.1*\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmfcovington%2Fdjango-markupfield-helpers","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmfcovington%2Fdjango-markupfield-helpers","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmfcovington%2Fdjango-markupfield-helpers/lists"}