Metadata-Version: 1.1
Name: django-exchange
Version: 0.7.1
Summary: currency, exchange rates and conversions support for django
Home-page: https://github.com/metglobal/django-exchange
Author: Metglobal
Author-email: kadir.pekel@metglobal.com
License: MIT
Description: ===============
        django-exchange
        ===============
        Currency, exchange rate and conversions support for django projects.
        
        Install
        -------
        
        ``django-exchange`` is available on pypi repositories so youre free to use
        ``pip`` or ``easy_install``::
        
            $ pip install django-exchange
        
        Or you might want to install from source::
        
            $ wget https://github.com/metglobal/django-exchange/archive/django-exchange-xxx.zip
            $ unzip django-exchange-xxx.zip
            $ cd django-exchange-xxx
            $ python setup.py install
        
        Add ``exchange`` into your ``INSTALLED_APPS`` settings of your django project::
        
            INSTALLED_APPS += [
                'exchange',
            ]
        
        Don't forget to sync your db to create corresponding database tables::
        
            $ python manage.py syncdb
        
        Populating Data
        ---------------
        
        django-exchange supports populating currency and exchange rates using a service provider
        automatically. Currently it has built in support for openexchangerates.org service. It is
        only a matter of supplying an api key obtained from http://openexchangerates.org as django
        settings using the key ``OPENEXCHANGERATES_API_KEY``::
        
            OPENEXCHANGERATES_API_KEY = '<YOU_API_KEY_HERE>'
        
        Now you can populate you currency and exchange rates magically by typing::
        
            $ python manage.py update_exchange_rates
        
        If you want to use you own service provider, you should consider implementing
        ``exchange.adapters.BaseAdapter`` class and pass you implementation class path
        as an argument to ``update_exchange_rates`` command::
        
            $ python manage.py update_exchange_rates -c myproj.providers.MyProvider
        
        Quickstart
        -----------
        
        Currency conversions is dead easy. There are auxilaray methods helps you calculate
        conversions using populated exchange rates under ``exchange.conversions`` module.
        
        Take a look at the example below::
        
            >>> from exchange.conversion import Price, convert
            >>> my_price = Price(50, 'USD')
            >>> my_price.convert('YEN')
            <Price (4678.50 YEN)>
        
        Documentation
        -------------
        
        Coming soon...
        
        Todo
        ----
        
        * Convenient template tags
        * Django price field implementation supporting currency conversions
        * Easier api with convenient refaactorings
        * A few more builtin exchange rate provider
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Topic :: Internet :: WWW/HTTP
