{"id":17874024,"url":"https://github.com/nigma/django-common-configs","last_synced_at":"2025-03-21T22:31:43.314Z","repository":{"id":13326378,"uuid":"16013235","full_name":"nigma/django-common-configs","owner":"nigma","description":"Convention over configuration. Common settings for Django projects.","archived":false,"fork":false,"pushed_at":"2014-01-23T15:51:55.000Z","size":184,"stargazers_count":10,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-18T05:43:56.886Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","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/nigma.png","metadata":{"files":{"readme":"README.rst","changelog":"HISTORY.rst","contributing":"CONTRIBUTING.rst","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-01-17T22:12:16.000Z","updated_at":"2017-07-23T12:15:45.000Z","dependencies_parsed_at":"2022-09-15T02:01:06.137Z","dependency_job_id":null,"html_url":"https://github.com/nigma/django-common-configs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nigma%2Fdjango-common-configs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nigma%2Fdjango-common-configs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nigma%2Fdjango-common-configs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nigma%2Fdjango-common-configs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nigma","download_url":"https://codeload.github.com/nigma/django-common-configs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244880285,"owners_count":20525506,"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":[],"created_at":"2024-10-28T11:07:21.000Z","updated_at":"2025-03-21T22:31:43.026Z","avatar_url":"https://github.com/nigma.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"=====================\ndjango-common-configs\n=====================\n\n.. image:: https://badge.fury.io/py/django-common-configs.png\n    :target: http://badge.fury.io/py/django-common-configs\n\n.. image:: https://pypip.in/d/django-common-configs/badge.png\n    :target: https://crate.io/packages/django-common-configs?version=latest\n\nCommon Configuration settings for Django projects.\n\nGoes in line with `12 factor app \u003chttp://12factor.net/config\u003e`_ and popular hosting\nplatforms like `Heroku \u003chttps://www.heroku.com/\u003e`_.\n\nDeveloped and used at `en.ig.ma software shop \u003chttp://en.ig.ma\u003e`_.\n\nOverview\n--------\n\nGetting Django and popular apps settings right require time and a bit of experience.\n\nThis project provides predefined and verified configs for various aspects\nof Django apps, promotes convention over configuration and allows to keep\n``settings.py`` file DRY.\n\nIt covers security, static files, assets compression, storage, AWS, celery,\nSentry, logging, integration with common services, Heroku and more.\n\nDeveloped at `en.ig.ma software shop \u003chttp://en.ig.ma\u003e`_\nand used in multiple `projects \u003chttp://en.ig.ma/projects\u003e`_.\n\nDocumentation\n-------------\n\nThe full documentation is at http://django-common-configs.rtfd.org.\n\nQuickstart\n----------\n\nSimplify Django project configuration in two easy steps:\n\nInclude ``django-common-configs`` and other related packages in your\n``requirements.txt`` file.\n\nInstall `django-configurations \u003chttp://django-configurations.rtfd.org/\u003e`_, add required\ncommon config mixins (they are just plain Python classes) to your ``settings.py``\nConfiguration classes and override base settings as necessary:\n\n\n.. code-block:: py\n\n    from common_configs import Configuration, values\n\n    from common_configs.django import Locale, SingleSite, DjangoSecurity\n    from common_configs.apps import CrispyForms, Imagekit, CeleryDev, CompressDev, CompressProd\n    from common_configs.logging import StructLoggingDev, StructLoggingProd\n    from common_configs.paas.heroku import Heroku, CeleryHerokuBigWig\n    from common_configs.services import APNS, GCM, CacheDev, AWS, Mailgun, Sendgrid, Raven, Pusher, Twilio\n    from common_configs.storage import LocalCompressStorage, AWSCompressStorage\n\n\n    class Common(Locale, SingleSite,\n                 CrispyForms, Imagekit, APNS, GCM,\n                 Configuration):\n\n        DEBUG = False\n        TEMPLATE_DEBUG = False\n\n\n    class DevConfig(LocalCompressStorage, CeleryDev, CompressDev, StructLoggingDev, CacheDev,\n                    Common):\n\n        DEBUG = True\n        TEMPLATE_DEBUG = True\n        DATABASES = values.DatabaseURLValue(\"postgres://...\")\n\n\n    class ProdConfig(AWS, AWSCompressStorage, CeleryHerokuBigWig, CompressProd, StructLoggingProd,\n                     Heroku, Mailgun, Raven, Pusher, Twilio,\n                     DjangoSecurity,\n                     Common):\n        pass\n\n\n.. _dependencies:\n\nDependencies\n------------\n\n``django-common-configs`` depends on ``django-configurations\u003e=0.7`` and optionally on the following packages:\n\n=============== ======================================================================================================\nModule              Requirements\n=============== ======================================================================================================\nsecurity        ``django-secure\u003e=1.0``, ``django_csp\u003e=2.0.3``\ncompress        ``django_compressor\u003e=1.3``\ndebug           ``django-debug-toolbar\u003e=1.0.1``\nauth            ``django-allauth\u003e=0.15.0``\nforms           ``django-crispy-forms\u003e=1.4.0``\nimagekit        ``django-imagekit\u003e=3.2``\npusher          ``pusher\u003e=0.8``\nsentry          ``raven\u003e=4.0.3``\nstorage         ``boto\u003e=2.23.0``, ``django-storages\u003e=1.1.8``, ``Collectfast\u003e=0.1.13``\nlogging         ``django-log-request-id\u003e=0.0.3``\nstructlog       ``structlog\u003e=0.4.1``, ``django-log-request-id\u003e=0.0.3``\ntwilio          ``twilio``\nheroku          ``django-pylibmc-sasl\u003e=0.2.4``, ``django-heroku-memcacheify\u003e=0.4``, ``django-heroku-postgresify\u003e=0.3``\n=============== ======================================================================================================\n\nAll dependencies can be easily added to your ``requirements.txt`` file by specifying it using pip syntax::\n\n    django-common-configs[security,compress,debug,auth,forms,imagekit,pusher,sentry,storage,structlog,twilio,heroku]==0.1.0\n\n\nLicense\n-------\n\n``django-common-configs`` is released under the BSD license.\n\nOther Resources\n---------------\n\n- GitHub repository - https://github.com/nigma/django-common-configs\n- PyPi Package site - http://pypi.python.org/pypi/django-common-configs\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnigma%2Fdjango-common-configs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnigma%2Fdjango-common-configs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnigma%2Fdjango-common-configs/lists"}