| Name | django-setup-configuration JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | Pluggable configuration setup used with the django management command |
| upload_time | 2024-03-25 11:27:46 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | Copyright 2024 Maykin Media 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. |
| keywords |
django
configuration
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
Welcome to django_setup_configuration's documentation!
======================================================
:Version: 0.1.0
:Source: https://github.com/maykinmedia/django-setup-configuration
:Keywords: Configuration
:PythonVersion: 3.10
|build-status| |code-quality| |black| |coverage| |docs|
|python-versions| |django-versions| |pypi-version|
Manage your configuration via django command.
.. contents::
.. section-numbering::
Features
========
* management command, which runs the ordered list of all configuration steps
Installation
============
Requirements
------------
* Python 3.10 or above
* Django 3.2 or newer
Install
-------
1. Install from PyPI
.. code-block:: bash
pip install django-setup-configuration
2. Add ``django_setup_configuration`` to the ``INSTALLED_APPS`` setting.
Usage
=====
1. Create configurations steps based on ``BaseConfigurationStep`` class.
2. Specify these steps in ``SETUP_CONFIGURATION_STEPS`` setting.
3. Run ``setup_configuration`` management command manually or put it in the init container
during deployment.
Local development
=================
To install and develop the library locally, use:
.. code-block:: bash
pip install -e .[tests,coverage,docs,release]
When running management commands via ``django-admin``, make sure to add the root
directory to the python path (or use ``python -m django <command>``):
.. code-block:: bash
export PYTHONPATH=. DJANGO_SETTINGS_MODULE=testapp.settings
django-admin check
# or other commands like:
# django-admin makemessages -l nl
.. |build-status| image:: https://github.com/maykinmedia/django_setup_configuration/workflows/Run%20CI/badge.svg
:alt: Build status
:target: https://github.com/maykinmedia/django_setup_configuration/actions?query=workflow%3A%22Run+CI%22
.. |code-quality| image:: https://github.com/maykinmedia/django_setup_configuration/workflows/Code%20quality%20checks/badge.svg
:alt: Code quality checks
:target: https://github.com/maykinmedia/django_setup_configuration/actions?query=workflow%3A%22Code+quality+checks%22
.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
.. |coverage| image:: https://codecov.io/gh/maykinmedia/django_setup_configuration/branch/main/graph/badge.svg
:target: https://codecov.io/gh/maykinmedia/django_setup_configuration
:alt: Coverage status
.. |docs| image:: https://readthedocs.org/projects/django_setup_configuration/badge/?version=latest
:target: https://django_setup_configuration.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. |python-versions| image:: https://img.shields.io/pypi/pyversions/django_setup_configuration.svg
.. |django-versions| image:: https://img.shields.io/pypi/djversions/django_setup_configuration.svg
.. |pypi-version| image:: https://img.shields.io/pypi/v/django_setup_configuration.svg
:target: https://pypi.org/project/django_setup_configuration/
Raw data
{
"_id": null,
"home_page": null,
"name": "django-setup-configuration",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "Django, Configuration",
"author": null,
"author_email": "Maykin Media <support@maykinmedia.nl>",
"download_url": "https://files.pythonhosted.org/packages/b9/ea/17f526e117017587221f049568c8bdcd8ca42da6f97223145cce4381f924/django_setup_configuration-0.1.0.tar.gz",
"platform": null,
"description": "\n\nWelcome to django_setup_configuration's documentation!\n======================================================\n\n:Version: 0.1.0\n:Source: https://github.com/maykinmedia/django-setup-configuration\n:Keywords: Configuration\n:PythonVersion: 3.10\n\n|build-status| |code-quality| |black| |coverage| |docs|\n\n|python-versions| |django-versions| |pypi-version|\n\nManage your configuration via django command.\n\n.. contents::\n\n.. section-numbering::\n\nFeatures\n========\n\n* management command, which runs the ordered list of all configuration steps\n\nInstallation\n============\n\nRequirements\n------------\n\n* Python 3.10 or above\n* Django 3.2 or newer\n\n\nInstall\n-------\n\n1. Install from PyPI\n\n.. code-block:: bash\n\n pip install django-setup-configuration\n\n2. Add ``django_setup_configuration`` to the ``INSTALLED_APPS`` setting.\n\n\nUsage\n=====\n\n1. Create configurations steps based on ``BaseConfigurationStep`` class.\n\n2. Specify these steps in ``SETUP_CONFIGURATION_STEPS`` setting.\n\n3. Run ``setup_configuration`` management command manually or put it in the init container\n during deployment.\n\n\nLocal development\n=================\n\nTo install and develop the library locally, use:\n\n.. code-block:: bash\n\n pip install -e .[tests,coverage,docs,release]\n\nWhen running management commands via ``django-admin``, make sure to add the root\ndirectory to the python path (or use ``python -m django <command>``):\n\n.. code-block:: bash\n\n export PYTHONPATH=. DJANGO_SETTINGS_MODULE=testapp.settings\n django-admin check\n # or other commands like:\n # django-admin makemessages -l nl\n\n\n.. |build-status| image:: https://github.com/maykinmedia/django_setup_configuration/workflows/Run%20CI/badge.svg\n :alt: Build status\n :target: https://github.com/maykinmedia/django_setup_configuration/actions?query=workflow%3A%22Run+CI%22\n\n.. |code-quality| image:: https://github.com/maykinmedia/django_setup_configuration/workflows/Code%20quality%20checks/badge.svg\n :alt: Code quality checks\n :target: https://github.com/maykinmedia/django_setup_configuration/actions?query=workflow%3A%22Code+quality+checks%22\n\n.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n\n.. |coverage| image:: https://codecov.io/gh/maykinmedia/django_setup_configuration/branch/main/graph/badge.svg\n :target: https://codecov.io/gh/maykinmedia/django_setup_configuration\n :alt: Coverage status\n\n.. |docs| image:: https://readthedocs.org/projects/django_setup_configuration/badge/?version=latest\n :target: https://django_setup_configuration.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\n.. |python-versions| image:: https://img.shields.io/pypi/pyversions/django_setup_configuration.svg\n\n.. |django-versions| image:: https://img.shields.io/pypi/djversions/django_setup_configuration.svg\n\n.. |pypi-version| image:: https://img.shields.io/pypi/v/django_setup_configuration.svg\n :target: https://pypi.org/project/django_setup_configuration/\n",
"bugtrack_url": null,
"license": "Copyright 2024 Maykin Media 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. ",
"summary": "Pluggable configuration setup used with the django management command",
"version": "0.1.0",
"project_urls": {
"Bug Tracker": "https://github.com/maykinmedia/django-setup-configuration/issues",
"Documentation": "http://django-setup-configuration.readthedocs.io/en/latest/",
"Homepage": "https://github.com/maykinmedia/django-setup-configuration",
"Source Code": "https://github.com/maykinmedia/django-setup-configuration"
},
"split_keywords": [
"django",
" configuration"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "09a6e497e9ae0c4c0586035d6ba55ac79798459f6a0ed08b890a02a67951446c",
"md5": "d6ead46bfcd75de649aa21058b2fbb88",
"sha256": "dfa8d086b779d7c79b716a0571262eefc987e43fa39350d2a4cbf64882a7c279"
},
"downloads": -1,
"filename": "django_setup_configuration-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d6ead46bfcd75de649aa21058b2fbb88",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 7878,
"upload_time": "2024-03-25T11:27:44",
"upload_time_iso_8601": "2024-03-25T11:27:44.494081Z",
"url": "https://files.pythonhosted.org/packages/09/a6/e497e9ae0c4c0586035d6ba55ac79798459f6a0ed08b890a02a67951446c/django_setup_configuration-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b9ea17f526e117017587221f049568c8bdcd8ca42da6f97223145cce4381f924",
"md5": "eb324ca2738e2c03bbcb0faa45805169",
"sha256": "42a2b5783b893dd0316080f658ab9e5448c292b7f7c35aa1eed5457e948e5fb2"
},
"downloads": -1,
"filename": "django_setup_configuration-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "eb324ca2738e2c03bbcb0faa45805169",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 9443,
"upload_time": "2024-03-25T11:27:46",
"upload_time_iso_8601": "2024-03-25T11:27:46.667225Z",
"url": "https://files.pythonhosted.org/packages/b9/ea/17f526e117017587221f049568c8bdcd8ca42da6f97223145cce4381f924/django_setup_configuration-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-25 11:27:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "maykinmedia",
"github_project": "django-setup-configuration",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "django-setup-configuration"
}
