django-chile-cities 1.0.0__tar.gz

django_chile_cities-1.0.0/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2024, Daniel Cristóbal Ojeda Sandoval
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice,
+   this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

django_chile_cities-1.0.0/MANIFEST.in

@@ -0,0 +1,5 @@
+include LICENSE
+include README.rst
+recursive-include django_chile_cities/fixtures *
+recursive-include django_chile_cities/management *.py
+recursive-include docs *

django_chile_cities-1.0.0/PKG-INFO

@@ -0,0 +1,81 @@
+Metadata-Version: 2.1
+Name: django_chile_cities
+Version: 1.0.0
+Summary: Una librería Django para manejar regiones, provincias y ciudades en Chile.
+Home-page: https://github.com/NewDevCoop/django-chile-cities
+Author: Daniel Ojeda
+Author-email: danielo@newdev.cl
+License: BSD-3-Clause
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 3.2
+Classifier: Framework :: Django :: 4.0
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: django>=3.2
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-django; extra == "dev"
+Requires-Dist: tox; extra == "dev"
+Requires-Dist: coverage; extra == "dev"
+
+# Chile Cities
+
+**Chile Cities** is a Django app to load cities and regions of Chile.
+
+Detailed documentation is in the `docs` directory.
+
+## Quick Start
+
+1. Add `chile-cities` to your `INSTALLED_APPS` setting like this:
+
+    ```python
+    INSTALLED_APPS = [
+        ...,
+        "django_chile_cities",
+    ]
+    ```
+
+2. Run the following command to create the `chile-cities` models:
+
+    ```bash
+    python manage.py migrate
+    ```
+
+3. Load the seed data by running:
+
+    ```bash
+    python manage.py load-chile-cities
+    ```
+
+## Usage
+
+1. Import `django_chile_cities` models in your project:
+
+    ```python
+    from django_chile_cities.models import Region, Province, City
+
+    class MyTable(models.Model):
+        ...
+        city = models.ForeignKey(City, on_delete=models.PROTECT)
+    ```
+
+2. Access to province and region trough city instance:
+
+    ```python
+
+    my_table_instance.city.province.region
+
+    ```
+
+And that's it, simple, but needed in multiple projects.

django_chile_cities-1.0.0/README.md

@@ -0,0 +1,50 @@
+# Chile Cities
+
+**Chile Cities** is a Django app to load cities and regions of Chile.
+
+Detailed documentation is in the `docs` directory.
+
+## Quick Start
+
+1. Add `chile-cities` to your `INSTALLED_APPS` setting like this:
+
+    ```python
+    INSTALLED_APPS = [
+        ...,
+        "django_chile_cities",
+    ]
+    ```
+
+2. Run the following command to create the `chile-cities` models:
+
+    ```bash
+    python manage.py migrate
+    ```
+
+3. Load the seed data by running:
+
+    ```bash
+    python manage.py load-chile-cities
+    ```
+
+## Usage
+
+1. Import `django_chile_cities` models in your project:
+
+    ```python
+    from django_chile_cities.models import Region, Province, City
+
+    class MyTable(models.Model):
+        ...
+        city = models.ForeignKey(City, on_delete=models.PROTECT)
+    ```
+
+2. Access to province and region trough city instance:
+
+    ```python
+
+    my_table_instance.city.province.region
+
+    ```
+
+And that's it, simple, but needed in multiple projects.

django_chile_cities-1.0.0/README.rst

@@ -0,0 +1,51 @@
+Chile Cities
+============
+
+**Chile Cities** is a Django app to load cities and regions of Chile.
+
+Detailed documentation is in the ``docs`` directory.
+
+Quick Start
+-----------
+
+1. Add ``chile-cities`` to your ``INSTALLED_APPS`` setting like this:
+
+   .. code-block:: python
+
+       INSTALLED_APPS = [
+           ...,
+           "django_chile_cities",
+       ]
+
+2. Run the following command to create the ``chile-cities`` models:
+
+   .. code-block:: bash
+
+       python manage.py migrate
+
+3. Load the seed data by running:
+
+   .. code-block:: bash
+
+       python manage.py load-chile-cities
+
+Usage
+-----
+
+1. Import ``django_chile_cities`` models in your project:
+
+   .. code-block:: python
+
+       from django_chile_cities.models import Region, Province, City
+
+       class MyTable(models.Model):
+           ...
+           city = models.ForeignKey(City, on_delete=models.PROTECT)
+
+2. Access province and region through city instance:
+
+   .. code-block:: python
+
+       my_table_instance.city.province.region
+
+And that's it, simple, but needed in multiple projects.

django_chile_cities-1.0.0/django_chile_cities/admin.py

@@ -0,0 +1,3 @@
+from django.contrib import admin
+
+# Register your models here.

django_chile_cities-1.0.0/django_chile_cities/apps.py

@@ -0,0 +1,5 @@
+from django.apps import AppConfig
+
+
+class ChileCitiesConfig(AppConfig):
+    name = 'django_chile_cities'

django_chile_cities-1.0.0/django_chile_cities/factories.py

@@ -0,0 +1,26 @@
+from factory.django import DjangoModelFactory
+from factory import SubFactory
+
+
+class RegionFactory(DjangoModelFactory):
+    class Meta:
+        model = 'chile_cities.region'
+
+    name = 'region 1'
+    iso_3166_2_cl = 'CL'
+
+
+class ProvinceFactory(DjangoModelFactory):
+    class Meta:
+        model = 'chile_cities.province'
+
+    name = 'provincia 1'
+    region = SubFactory(RegionFactory)
+
+
+class CityFactory(DjangoModelFactory):
+    class Meta:
+        model = 'chile_cities.city'
+
+    name = 'ciudad 1'
+    province = SubFactory(ProvinceFactory)