Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sageteamorg/django-iranian-cities
https://github.com/sageteamorg/django-iranian-cities
django django-pac
Last synced: 5 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/sageteamorg/django-iranian-cities
- Owner: sageteamorg
- License: gpl-3.0
- Created: 2021-08-14T20:20:45.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-08-30T08:01:57.000Z (3 months ago)
- Last Synced: 2024-11-09T17:05:36.885Z (6 days ago)
- Topics: django, django-pac
- Language: Python
- Homepage:
- Size: 2.04 MB
- Stars: 29
- Watchers: 2
- Forks: 8
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Django Iranian Cities
The [django-iranian-cities](https://github.com/sageteam-org/django-iranian-cities) is a valuable package based on Django Web Framework for Iranian cities support. You can see full documentation here [readthedocs](https://django-iranian-cities.readthedocs.io/).
[](http://sageteam.org)
- [Project Detail](#project-detail)
- [Get Started](#getting-started)
- [Usage](#usage)
- [Settings](#settings)
- [Git Rules](#git-rules)
## Project Detail
- Language: Python > 3.8
- Framework: Django > 4.2
## Getting Started
1. **Install the package**:
```shell
$ pip install django-iranian-cities
```
2. **Add `iranian_cities` to INSTALLED_APPS in your Django settings**:
```python
INSTALLED_APPS = [
...
'iranian_cities',
...
]
```
3. **Run migrations to apply model changes**:
```shell
$ python manage.py migrate
```
4. **Generate Data**:
To populate the database with Iranian cities data, use the provided management command. This command will:
- Check if there is existing data in the tables.
- Prompt you to confirm if you want to **flush** the tables if they already contain data.
- Read **CSV** files and populate the `Province`, `County`, `District`, `City`, `RuralDistrict`, and `Village` tables with data.
```shell
$ python manage.py generate_city
```
If **tables** contain data, you will be prompted to either **flush** them or **cancel** the operation.
## Usage
You can use the provided fields and admin mixin in your Django models:
- **Fields**:
```python
from django.db import models
from iranian_cities.fields import ProvinceField
class TestModel(models.Model):
province = ProvinceField()
```
**list of fields**:
- ProvinceField
- CountyField
- DistrictField
- CityField
- RuralDistrictField
- VillageField
- **Admin**:
```python
from django.contrib import admin
from iranian_cities.admin import IranianCitiesAdmin
from test_app.models import TestModel
@admin.register(TestModel)
class TestModelAdmin(IranianCitiesAdmin):
pass
```
## Settings
The package uses several settings for configuration. Make sure the following settings are defined in your `settings.py` file:
```python
IRANIAN_CITIES_ADMIN_ADD_READONLY_ENABLED = True
IRANIAN_CITIES_ADMIN_DELETE_READONLY_ENABLED = True
IRANIAN_CITIES_ADMIN_CHANGE_READONLY_ENABLED = True
IRANIAN_CITIES_ADMIN_INLINE_ENABLED = False
```
Explanation of **settings**:
- `IRANIAN_CITIES_ADMIN_ADD_READONLY_ENABLED`: When set to `True`, users can add new entries to the admin interface. Set to `False` to disable adding entries.
- `IRANIAN_CITIES_ADMIN_DELETE_READONLY_ENABLED`: When set to `True`, users can delete existing entries in the admin interface. Set to `False` to disable deleting entries.
- `IRANIAN_CITIES_ADMIN_CHANGE_READONLY_ENABLED`: When set to `True`, users can change existing entries in the admin interface. Set to `False` to disable changes.
- `IRANIAN_CITIES_ADMIN_INLINE_ENABLED`: When set to `True`, inline admin forms are enabled based on the model type. Set to `False` to disable inline forms.
## Git Rules
S.A.G.E. team Git Rules Policy is available here:
- [S.A.G.E. Git Policy](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow)