Metadata-Version: 1.1
Name: django-osm
Version: 0.1.0
Summary: Project Open Street Map management
Home-page: https://github.com/dcopm999/django-osm
Author: Pavel Tanchev
Author-email: dcopm999@gmail.com
License: MIT
Description: =============================
        django-osm
        =============================
        
        .. image:: https://badge.fury.io/py/django-osm.svg
            :target: https://badge.fury.io/py/django-osm
        
        .. image:: https://app.travis-ci.com/dcopm999/django-osm.svg?branch=master
            :target: https://app.travis-ci.com/github/dcopm999/django-osm
        
        .. image:: https://codecov.io/gh/dcopm999/django-osm/branch/master/graph/badge.svg
            :target: https://codecov.io/gh/dcopm999/django-osm
        
        Project Open Street Map management
        
        Documentation
        -------------
        
        The full documentation is at https://django-osm.readthedocs.io.
        
        Quickstart
        ----------
        
        Install django-osm::
        
            pip install django-osm
        
        Add it to your `INSTALLED_APPS`:
        
        .. code-block:: python
        
            INSTALLED_APPS = (
                ...
        	"django.contrib.gis",
        	"django_celery_beat",
        	"rest_framework",
        	"rest_framework_gis",
                "osm",
                ...
            )
        
            DATABASE_ROUTERS = [
                ...
                'osm.route_db.Default'
            ]
        
            DATABASES = {
                ...
                'osm': {
        	    'ENGINE': 'django.contrib.gis.db.backends.postgis',
        	    'HOST': 'localhost',
        	    'NAME': 'geodjango',
        	},
            }
            OSM_REPLICS = ['osm']
        
        
        If there is OSM database replication, then add the connection parameters to us in the list of databases:
        
        .. code-block:: python
        
               DATABASES = {
                   ...
        	   'osm_replica1': {
        	       'ENGINE': 'django.contrib.gis.db.backends.postgis',
        	       'HOST': 'localhost',
        	       'NAME': 'geodjango',
        	       },
        
               }
        
        And complete the list of replicas OSM_REPLICS:
        
        .. code-block:: python
        
           OSM_REPLICS = ['osm', 'osm_replica1']
        
        
        Add django-osm's URL patterns:
        
        .. code-block:: python
        
            urlpatterns = [
                ...
                path('osm/', include('osm.urls', namespace='osm')),
                ...
            ]
        
        
        Add DRF settings:
        
        .. code-block:: python
        
            REST_FRAMEWORK = {
        	"DEFAULT_AUTHENTICATION_CLASSES": (
        	    "rest_framework.authentication.SessionAuthentication",
        	    "rest_framework.authentication.TokenAuthentication",
        	),
        	"DEFAULT_PERMISSION_CLASSES": ("rest_framework.permissions.IsAuthenticated",),
        	'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.LimitOffsetPagination',
        	'PAGE_SIZE': 25
           }
        
        
        Features
        --------
        
        * TODO
        
        Running Tests
        -------------
        
        Does the code actually work?
        
        ::
        
            source <YOURVIRTUALENV>/bin/activate
            (myenv) $ pip install tox
            (myenv) $ tox
        
        
        Development commands
        ---------------------
        
        ::
        
            pip install -r requirements_dev.txt
            invoke -l
        
        
        Credits
        -------
        
        Tools used in rendering this package:
        
        *  Cookiecutter_
        *  `cookiecutter-djangopackage`_
        
        .. _Cookiecutter: https://github.com/audreyr/cookiecutter
        .. _`cookiecutter-djangopackage`: https://github.com/pydanny/cookiecutter-djangopackage
        
        
        
        
        History
        -------
        
        0.1.0 (2021-01-16)
        ++++++++++++++++++
        
        * First release on PyPI.
        
Keywords: django-osm
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Django :: 2.1
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
