Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mhsiddiqui/django-bongpy
Dynamic Configuration for your Django project
https://github.com/mhsiddiqui/django-bongpy
configuration-management django django-admin python
Last synced: about 2 months ago
JSON representation
Dynamic Configuration for your Django project
- Host: GitHub
- URL: https://github.com/mhsiddiqui/django-bongpy
- Owner: mhsiddiqui
- License: mit
- Created: 2022-02-14T21:04:25.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-08-13T13:14:04.000Z (over 1 year ago)
- Last Synced: 2024-11-06T23:13:02.642Z (2 months ago)
- Topics: configuration-management, django, django-admin, python
- Language: Python
- Homepage: https://pypi.org/project/django-bongpy/
- Size: 197 KB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# django-bongpy
[](https://github.com/mhsiddiqui/django-bongpy/actions/workflows/test.yml) [](https://codecov.io/gh/mhsiddiqui/django-bongpy)
Django-bongpy provides dynamic configuration for your Django project which you can control from Django admin. You can change your configurations at any time without any deployment.
**Note**: You cannot add settings required for Django to operate in this like *INSTALLED_APPS*
# Requirements
* Python > 3
* Django > 1.10
# Setup
1. Run below command to install.
> pip install django-bongpy
2. Add `bongpy` in your INSTALLED_APPS.
3. Run migration by running following command
> python manage.py migrate
# Usage
_____
Just go to your admin dashboard, in the Bongpy section, add configurations.
## Config Type
It supports the following types of configurations. You need to set the correct type for your value otherwise value will be treated as string value and will not be processed into actual data type.
* String
* Number
* Boolean
* Json
* Date
* Datetime
* Time
### String
By default every value will be string.
### Number
Number includes integers as well as decimal numbers.
### Boolean
For boolean value, see below chart.
| True | False |
|:----:|:-----:|
| t | f |
| T | F |
| y | n |
| Y | N |
| yes | no |
| YES | NO |
| true | false |
| True | False |
| TRUE | FALSE |
| on | off |
| On | Off |
| ON | OFF |
| 1 | 0 |
### Json
A valid json is required when the config type is selected as Json.
### Date
Date should be in `YYYY-MM-DD` format. It will be converted to `datetime.date` object.
### Datetime
Datetime should be in `YYYY-MM-DD HH:MM:SS` format and it will be converted to `datetime` object.
### Time
Time should be in `HH:MM:SS` format and it will be converted to `datetime.time` object.
## Usage in code
In your code, you can use it like this.
```python
from bongpy.configs import configs
print(configs.KEY_OF_YOUR_CONFIGURATION)
```
At any time, when you will change your config value or add a new value, it will be available to use in you code.
## Grouping
You can group configurations. Configurations of a particular group can be accessed like this.
```python
from bongpy.configs import configs
print(configs.grouped(group='NAME_OF_GROUP'))
```
## Default value
It is quite possible when you are using a configuration in your code and you have not added that configuration yet. In this case it is best to define a default value of that configuration in your settings so that that default value will be used instead of an error. To define default value of your configurations, define `BONGPY_DEFAULTS` in settings like this
```python
BONGPY_DEFAULTS = {
"KEY_1": True,
"KEY_2": 2000
}
```
When this key will be added, that value will be used instead of this default value. These configurations will be loaded in database automatically.