django-oscar 3.2.3a1

A domain-driven e-commerce framework for Django

Domain-driven e-commerce for Django

Oscar is an e-commerce framework for Django designed for building domain-driven sites. It is structured such that any part of the core functionality can be customised to suit the needs of your project. This allows a wide range of e-commerce requirements to be handled, from large-scale B2C sites to complex B2B sites rich in domain-specific business logic.

Contents:

• Supported versions

• Screenshots

• Extensions

• Videos

• License

• Contributing to the Project

• Code of Conduct

• Our Pledge

• Our Standards

• Our Responsibilities

• Enforcement

  • Looking for commercial support?

Further reading:

• Official homepage

• Sandbox site (automatically deployed via the official docker sandbox image)

• Documentation on the excellent readthedocs.org

• Docker image on http://hub.docker.com/

• django-oscar group - mailing list for questions and announcements

• Twitter account for news and updates

• Discord

• PyPI page

• Transifex project - translating Oscar made easy

Core team:

• David Winterbottom (Twitter @codeinthehole)

• Maik Hoepfel (Twitter @maikhoepfel)

• Markus Bertheau

• Michael van Tellingen

• Alexander Gaevsky

• Samir Shah

Supported versions

The currently supported versions of Oscar are:

Version	End of support
3.2 LTS	January 2026
3.1	April 2022
3.0	May 2021
2.2 LTS	August 2023

Supported verions are eligible for fixes for data loss bugs and security issues. Releases designated as Long-term support (LTS) releases will receive support for an extended period of 3 years from their release date.

Screenshots

Sandbox

These are screenshots from the ‘sandbox’ example site that ships with Oscar. It sports a simple design built with Twitter’s Bootstrap and provides a good starting point for rapidly building elegant e-commerce sites.

The sandbox site is also available to browse at https://latest.oscarcommerce.com.

The sandbox site can be set-up locally in 5 commands. Want to make changes? Check out the contributing guidelines.

Extensions

The following extensions are stable and ready for use:

• django-oscar-api - RESTful JSON API for django-oscar

• django-oscar-adyen - Integration with the Adyen payment gateway

• django-oscar-datacash - Integration with the DataCash payment gateway

• django-oscar-paypal - Integration with PayPal. This currently supports both Express Checkout and PayFlow Pro.

• django-oscar-paymentexpress - Integration with the Payment Express payment gateway

• django-oscar-accounts - Managed accounts (can be used for giftcard functionality and loyalty schemes)

• django-oscar-stores - Physical stores integration (opening hours, store locator etc)

• django-oscar-sagepay-direct - Integration with “DIRECT” part of Sagepay’s API

• django_oscar_docdata - Integration with Docdata payment gateway.

• django_oscar_invoices - Invoices or receipts generation for the Oscar

The following are community-written extensions:

• django-oscar-payments - Pluggable payments for Oscar

• oscar-sagepay - Payment integration with Sage Pay

• django-oscar-support - Customer services and ticketing plugin for Oscar

• django-oscar-api-checkout - Oscar API Checkout is a layer on top of django-oscar and django-oscar-api, adding support for more complex and multiple payment options during an API checkout.

• django-oscar-bundles - Oscar Bundles adds multi-product bundles to django-oscar.

• django-oscar-bluelight - Bluelight Specials is a layer on-top of django-oscar that adds support for more complex offers and vouchers, including conjunctive and disjunctive compound conditions.

• django-oscar-cch - Oscar CCH is a plugin for django-oscar adding support for calculating taxes using the Wolters Kluwer CCH Sales Tax Office SOAP API.

• django-oscar-cybersource - Oscar CyberSource is a plugin for Oscar API Checkout that makes it possible to use CyberSource Secure Acceptance Silent Order Post as an order payment method.

• django-oscar-wfrs - Oscar WFRS is a plugin for django-oscar-api-checkout that makes it possible to use Wells Fargo Retail Services as an order payment method.

• django-oscar-zarinpal-gateway - Payment gateway integration for Zarinpal Payments in django-oscar. Zarinpal Payments is a large payment gateway based in The I.R. Iran .

Let us know if you’re writing a new one!

Videos

Videos with talks about Oscar:

• An introduction to Django-oscar by David Winterbottom, DjangoCon Europe 2014

• Oscar and the art of transactional Django applications by David Winterbottom, PyCon PL 2014

• The Tale of Oscar and the API by Kees Hink, PyGrunn 2017

License

Oscar is released under the permissive New BSD license (see summary).

Contributing to the Project

We welcome contributions to the project! Whether it’s a bug fix, a new feature, or just some documentation improvements, your contributions are greatly appreciated.

To contribute, please follow these steps:

Fork the project repository on GitHub. Clone your forked repository to your local machine. Create a new branch for your changes. Make your changes, and commit them with clear commit messages. Push your changes to your forked repository. Open a pull request on the original project repository, explaining your changes. Please note that all contributions are subject to review, and may be modified or rejected if they do not meet the project’s standards.

Code of Conduct

We want everyone involved in the project to feel safe and respected, regardless of their background or identity. As such, we have adopted the following Code of Conduct:

Our Pledge

In the interest of fostering an open and welcoming environment, we pledge to:

Be friendly and welcoming to all contributors. Respect differing viewpoints and experiences. Accept constructive criticism and feedback graciously. Focus on what is best for the community and the project.

Our Standards

We expect all contributors to:

Use welcoming and inclusive language. Be respectful of differing viewpoints and experiences. Gracefully accept constructive criticism. Focus on what is best for the community and the project.

Our Responsibilities

Project maintainers are responsible for:

Enforcing the Code of Conduct. Investigating and addressing reported violations of the Code of Conduct. Making clear and fair decisions about disciplinary actions for violations of the Code of Conduct. Scope This Code of Conduct applies to all contributors, both online and offline, in all project spaces, including but not limited to project forums, mailing lists, GitHub repositories, and in-person events.

Enforcement

If you witness or experience unacceptable behavior, or have any other concerns, please notify the project maintainers at [e-mail] & [e-mail]. All reports will be kept confidential, and the project maintainers will work with you to determine a resolution.

We reserve the right to take any action deemed necessary to enforce this Code of Conduct, including but not limited to warning the offender, banning the offender from the project’s spaces, or reporting the offender to relevant authorities. Case studies ————

Oscar is still in active development but is used in production by a range of companies, from large multinationals to small, boutique stores. See http://oscarcommerce.com/cases.html for an overview.

Many more on the way. If you use Oscar in production, please let us know.

Looking for commercial support?

If you are interested in having an Oscar project built for you, or for development of an existing Oscar site then please get in touch via [e-mail].