=================== django-helcim

|PyPI| |PythonVersions| |DjangoVersions| |License|

|BuildStatus| |Coverage|

.. |PyPI| image:: https://img.shields.io/pypi/v/django-helcim.svg :alt: PyPI

.. _PyPI: https://pypi.org/project/django-helcim/

.. |PythonVersions| image:: https://img.shields.io/pypi/pyversions/django-helcim.svg :alt: PyPI - Python Version

.. |DjangoVersions| image:: https://img.shields.io/pypi/djversions/django-helcim.svg :alt: PyPI - Django Version

.. |BuildStatus| image:: https://travis-ci.com/studybuffalo/django-helcim.svg?branch=master :alt: Travis-CI build status

.. _BuildStatus: https://travis-ci.com/studybuffalo/django-helcim

.. |Coverage| image:: https://codecov.io/gh/studybuffalo/django-helcim/branch/master/graph/badge.svg :alt: Codecov code coverage

.. _Coverage: https://codecov.io/gh/studybuffalo/django-helcim

.. |License| image:: https://img.shields.io/github/license/studybuffalo/django-helcim.svg :alt: License

.. _License: https://github.com/studybuffalo/django-helcim/blob/master/LICENSE

This package provides a Django-based integration with the Helcim Commerce API. It is designed to be easily implemented with existing Django-based commerce platforms and comes with an optional module to connect with Django Oscar_.

.. _Django: https://www.djangoproject.com/

.. _Helcim Commerce API: https://www.helcim.com/support/article/625-helcim-commerce-api-api-overview/

.. _Django Oscar: https://github.com/django-oscar/django-oscar

Getting Started

Instructions on installing and configuration can be found on Read The Docs_.

.. _Read The Docs: https://django-helcim.readthedocs.io/en/latest/

Support

The docs provide examples for setup and common issues to be aware of. If the issue involves connecting this package to Django Oscar, this repository contains a sandbox environment you can review for a minimal working example. For any other issues, you can submit a GitHub Issue_.

.. _docs provide examples for setup and common issues: https://django-helcim.readthedocs.io/en/latest/installation.html

.. _sandbox environment: https://django-helcim.readthedocs.io/en/latest/contributing.html#sandbox-website

.. _GitHub Issue: https://github.com/studybuffalo/django-helcim/issues

Contributing

Contributions are welcome, especially to address bugs and extend functionality. Full details on contributing can be found in the docs_.

.. _details on contributing can be found in the docs: https://django-helcim.readthedocs.io/en/latest/contributing.html

Versioning

This package uses a MAJOR.MINOR.PATCH versioning, as outlined at Semantic Versioning 2.0.0_.

.. _Semantic Versioning 2.0.0: https://semver.org/

Authors

Joshua Robert Torrance (StudyBuffalo_)

.. _StudyBuffalo: https://github.com/studybuffalo

License

This project is licensed under the GPLv3. Please see the LICENSE_ file for details.

.. _LICENSE: https://github.com/studybuffalo/django-helcim/blob/master/LICENSE

Acknowledgements

Thanks to the django-oscar-paypal_ developers, from which many of this packages design decisions are based.

.. _django-oscar-paypal: https://github.com/django-oscar/django-oscar-paypal

Changelog

You can view all package changes on the docs_.

.. _package changes on the docs: https://django-helcim.readthedocs.io/en/latest/changelog.html