Metadata-Version: 1.1
Name: django-pyowm
Version: 0.1.0
Summary: A Django ORM interface to operate with PyOWM domain entities
Home-page: https://github.com/csparpa/django_pyowm
Author: Claudio Sparpaglione
Author-email: csparpa@gmail.com
License: MIT License
Description: # django_pyowm
        
        A Django ORM interface for PyOWM domain entities
        
        
        ## Requirements
        
          - Django 1.10+
          - PyOWM 2.5+
        
        Python 2.7 and 3.2+ are supported.
        
        
        ## Install
        
        Add `django_pyowm` to the `INSTALLED_APPS` list into your Django project's `settings.py` file:
         
        ```python
        INSTALLED_APPS = [
            ...
            'django_pyowm'  # <---
        ]
        ```
        
        Then generate tables by applying migrations:
        
        ```shell
        $ python manage.py makemigrations django_pyowm
        $ python manage.py migrate
        ```
        
        
        ## Features
        Models behave as all other Django models but they have a few useful 
        functions:
        
          -  `<Model_class>.from_entity(entity)` - creates a PyOWM model instance
             from the corresponding PyOWM domain object instance
          -  `<Model_instance>.to_entity(entity)` - turns the model instance to
             the corresponding PyOWM domain object instance
        
        ## Quick usage examples
        
        ```python
        from pyowm import OWM
        from django_pyowm import models
        
        
        # Get data an Observation from the API 
        owm = OWM(API_key='my_key')
        obs = owm.weather_at_place('London,UK')
        
        # Create a model instance from API response
        m = models.Observation.from_entity(obs)
        
        # Save related objects and then the model itself
        m.location.save()
        m.weather.save()
        m.save()
        
        # .. or save everything in one shot
        m.save_all()
        
        # From model instance to entity
        original_obs = m.to_entity()
        ```
        
        ## Testing
        ```shell
        $ python runtests.py
        ```
        
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.10
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
