{"id":21001458,"url":"https://github.com/divio/aldryn-addons","last_synced_at":"2025-05-14T23:32:38.927Z","repository":{"id":1209069,"uuid":"41510883","full_name":"divio/aldryn-addons","owner":"divio","description":"This is the basis for the Divio Cloud Addon's Framework","archived":false,"fork":false,"pushed_at":"2024-03-24T13:51:28.000Z","size":47,"stargazers_count":2,"open_issues_count":0,"forks_count":2,"subscribers_count":17,"default_branch":"master","last_synced_at":"2025-04-03T01:11:09.599Z","etag":null,"topics":["addon","cloud","divio","django","python"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/divio.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,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2015-08-27T20:56:05.000Z","updated_at":"2022-04-08T08:18:43.000Z","dependencies_parsed_at":"2024-02-27T12:50:41.982Z","dependency_job_id":"a1814a81-c513-4343-9776-559fa5dcf0eb","html_url":"https://github.com/divio/aldryn-addons","commit_stats":{"total_commits":35,"total_committers":10,"mean_commits":3.5,"dds":0.6285714285714286,"last_synced_commit":"b619da93ea84b21dfa882f133952f005d00d1a90"},"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/divio%2Faldryn-addons","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/divio%2Faldryn-addons/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/divio%2Faldryn-addons/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/divio%2Faldryn-addons/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/divio","download_url":"https://codeload.github.com/divio/aldryn-addons/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254248443,"owners_count":22039008,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["addon","cloud","divio","django","python"],"created_at":"2024-11-19T08:15:24.167Z","updated_at":"2025-05-14T23:32:33.836Z","avatar_url":"https://github.com/divio.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"=======================\nAldryn Addons Framework\n=======================\n\n|pypi| |build|\n\n**Aldryn Addons** are re-usable django apps that follow certain conventions to\nabstract out complicated configuration from the individual django website\nproject into upgradable packages. With this approach it is possible\nto avoid repetitive \"add this to ``INSTALLED_APPS`` and that to\n``MIDDLEWARE_CLASSES`` and add these to ``urls.py``\" work. The settings logic\nis bundled with the addon and only interesting \"meta\" settings are exposed.\nIt is a framework to utilise such addons in django projects.\n\nThe goal is to keep the footprint inside the django website project as small\nas possible, so updating things usually just mean bumping a version in\n``requirements.txt`` and no other changes in the project.\n\nThis addon still uses the legacy \"Aldryn\" naming. You can read more about this in our\n`support section \u003chttps://support.divio.com/general/faq/essential-knowledge-what-is-aldryn\u003e`_.\n\n\nContributing\n============\n\nThis is a an open-source project. We'll be delighted to receive your\nfeedback in the form of issues and pull requests. Before submitting your\npull request, please review our `contribution guidelines\n\u003chttp://docs.django-cms.org/en/latest/contributing/index.html\u003e`_.\n\nWe're grateful to all contributors who have helped create and maintain this package.\nContributors are listed at the `contributors \u003chttps://github.com/divio/aldryn-addons/graphs/contributors\u003e`_\nsection.\n\n\nDocumentation\n=============\n\nSee ``REQUIREMENTS`` in the `setup.py \u003chttps://github.com/divio/aldryn-addons/blob/master/setup.py\u003e`_\nfile for additional dependencies:\n\n|python| |django|\n\n\nInstallation\n------------\n\n``aldryn-addons`` is part of the Divio Cloud platform.\n\nFor a manual install:\n\nAdd ``aldryn-addons`` to your projects ``requirements.txt`` or pip install it.\nIt is also highly recommended to install ``aldryn-django``. This is django\nitself bundled as an addon::\n\n    pip install aldryn-addons aldryn-django==1.6.11\n\nAt the top if the ``settings.py`` add the following code snippet::\n\n    INSTALLED_ADDONS = [\n        'aldryn-django',\n    ]\n\n    # add your own settings here that are needed by the installed Addons\n\n    import aldryn_addons.settings\n    aldryn_addons.settings.load(locals())\n\n    # add any other custom settings here\n\nAddons can automatically add code to the root ``urls.py`` so it's necessary\nto add ``aldryn_addons.urls.patterns()`` and\n``aldryn_addons.urls.i18n_patterns()``.\nThe code below is for Django 1.8 and above. For older versions of Django,\nplease add the prefix parameter to ``i18n_patterns``: ``i18n_patterns('', ...``\n::\n\n    from django.urls import re_path, include\n    from django.conf.urls.i18n import i18n_patterns\n    import aldryn_addons.urls\n\n\n    urlpatterns = [\n        # add your own patterns here\n    ] + aldryn_addons.urls.patterns() + i18n_patterns(\n        # add your own i18n patterns here\n        re_path(r'^myapp/', include('myapp.urls')),\n        *aldryn_addons.urls.i18n_patterns()  # MUST be the last entry!\n    )\n\n\nPlease follow the installation instructions for aldryn-django for complete\nintegration. Then follow the setup instructions for aldryn-django-cms\nfor the examples below.\n\n\nAdding Addons\n-------------\n\nIn this example we're going to install `django CMS Link \u003chttps://github.com/divio/djangocms-link/\u003e`_,\nwhich requires `Aldryn django CMS \u003chttps://github.com/aldryn/aldryn-django-cms/\u003e`_.\n\npip install the Addon::\n\n    pip install djangocms-link\n\nAdd it to ``INSTALLED_ADDONS`` in ``settings.py``::\n\n    INSTALLED_ADDONS = [\n        'aldryn-django',\n        'aldryn-cms',\n        'djangocms-link',\n    ]\n\nCopy ``aldryn_config.py`` and ``addon.json`` from the addon into the ``addons``\ndirectory within your project (``addons/djangocms-link/aldryn_config.py`` and\n``addons/djangocms-link/addon.json``). If ``aldryn_config.py`` defines any\nsettings on the settings Form, put them in\n``addons/djangocms-link/settings.json``, if not put ``{}`` into it.\n\n.. Note:: The need to manually copy ``aldryn_config.py`` and ``addon.json`` is\n          due to legacy compatibility with the Divio Cloud platform and will no\n          longer be necessary in a later release.\n\n.. Note:: Future versions will include a little webserver with a graphical UI\n          to edit the settings in ``settings.json``, much like it is provided\n          on the Divio Cloud platform.\n\n\nYou are all set. The code in ``aldryn_config.py`` will take care of configuring\nthe addon.\n\n\nRunning Tests\n-------------\n\nYou can run tests by executing::\n\n    virtualenv env\n    source env/bin/activate\n    pip install -r tests/requirements.txt\n    python setup.py test\n\n\n.. |pypi| image:: https://badge.fury.io/py/aldryn-addons.svg\n    :target: http://badge.fury.io/py/aldryn-addons\n.. |build| image:: https://github.com/divio/aldryn-addons/actions/workflows/default.yml/badge.svg?branch=master\n    :target: https://github.com/divio/aldryn-addons/actions\n.. |coverage| image:: https://codecov.io/gh/divio/aldryn-addons/branch/master/graph/badge.svg\n    :target: https://codecov.io/gh/divio/aldryn-addons\n\n.. |python| image:: https://img.shields.io/badge/python-3.8+-blue.svg\n    :target: https://pypi.org/project/aldryn-addons/\n.. |django| image:: https://img.shields.io/badge/django-3.2,%204.2,%205.0-blue.svg\n    :target: https://www.djangoproject.com/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdivio%2Faldryn-addons","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdivio%2Faldryn-addons","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdivio%2Faldryn-addons/lists"}