Skip to main content

An ecommerce inventory Django app.

Project description

django-inventory

Django-inventory is a Django app to perform full Ecommerce inventory functionality. You get to add product specific to a category, attribute, type and brand.

For better understanding of the project, kindly check out django-htmx and mptt documentation.

Detailed documentation is in the "docs" directory.

Quick start

  1. Add "inventory" to your INSTALLED_APPS setting like this::

    INSTALLED_APPS = [ ... 'inventory', 'django_htmx', 'mptt', ]

OR::

MIDDLEWARE = [
    ...
    'django_htmx.middleware.HtmxMiddleware',
]
  1. Include the inventory URLconf in your project urls.py like this::

    path('', include("inventory.urls", namespace="inventory")),

OR::

path('inventory/', include("inventory.urls", namespace="inventory")),
  1. Run python manage.py migrate to create the inventory models.

  2. Start the development server and visit http://127.0.0.1:8000/admin/ to create an inventory and for better understanding of the models structure (you'll need the Admin app enabled).

  3. Visit http://127.0.0.1:8000/inventory/ to participate in the inventory.

Optional Settings

  1. INVENTORY_HOME_HTML Default to "inventory/home.html" which serves as your homepage. You can override this template by adding INVENTORY_HOME_HTML = "your desired home html" to your settings file.

The home view comes with "products" and "featured" context data which can be manipulated as desired.

  1. INVENTORY_SHOP_HTML Default to "inventory/category.html" which serves as your shop page. You can override this template by adding INVENTORY_SHOP_HTML = "your desired shop html" to your settings file.

The shop view comes with "brands", "categories", "attributes" and "products" context which serves as a paginator also with and additional "url" context to issue a get request in the pagination section.

  1. INVENTORY_SHOP_SUBHTML This template encloses the products forloop section. Default to "inventory/partials/shop-element.html" which serves as your shop page. You can override this template by adding INVENTORY_SHOP_SUBHTML = "your desired shop element html" to your settings file.

implement this into your shop template by adding

{% include "inventory/partials/shop-element.html" %}

to your desired section/segment of your shop template.

  1. INVENTORY_PRODUCT_HTML Default to "inventory/single-product.html" which serves as your product detail page. You can override this template by adding INVENTORY_PRODUCT_HTML = "your desired product detail html" to your settings file.

This view comes with additional context of "attributes" and "values".

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-ecomstore-inventory-0.0.1.tar.gz (7.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

django_ecomstore_inventory-0.0.1-py3-none-any.whl (8.8 kB view details)

Uploaded Python 3

File details

Details for the file django-ecomstore-inventory-0.0.1.tar.gz.

File metadata

File hashes

Hashes for django-ecomstore-inventory-0.0.1.tar.gz
Algorithm Hash digest
SHA256 e408f22944e4b8aa33f40b29e00a91ee8fac80af599887c4a9fa075ccae97ba9
MD5 8f8b3a88826d74a1818f65163db51592
BLAKE2b-256 74b121ca750718940d271712e0545042fe403da9acec94aebda84097e9b18928

See more details on using hashes here.

File details

Details for the file django_ecomstore_inventory-0.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for django_ecomstore_inventory-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 073218cac129edbdd2f9b640c51d0d6a1026b92897ed7809b93784b89e0a1c62
MD5 cfae620a8170055c33ffb9061ba49ee7
BLAKE2b-256 50b0dd356c612b90c655916b52c181540a88a15142c3a527dba7bfb7f8c8f5d8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page