django-vendor


Namedjango-vendor JSON
Version 0.4.13 PyPI version JSON
download
home_page
SummaryDjango App Toolkit for selling digital and physical goods online.
upload_time2024-01-20 02:53:19
maintainer
docs_urlNone
authorRoberto Himmelbauer
requires_python>=3.7
license
keywords django app
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ![Django Vendor CI](https://github.com/renderbox/django-vendor/workflows/Django%20Vendor%20CI/badge.svg?branch=master)

![Django Vendor Develop](https://github.com/renderbox/django-vendor/workflows/Django%20Vendor%20Develop/badge.svg?branch=develop)

[![Documentation Status](https://readthedocs.org/projects/django-vendor/badge/?version=latest)](https://django-vendor.readthedocs.io/en/latest/?badge=latest)

# Django Vendor

Django App Toolkit for selling digital and physical goods online.

The philosophy is "Cart to Receipt".  What you put in the cart and what you do after the purchase is up to you.  The app is opinionated within scope.

Goals of the project:
- Drop in to existing Django Sites without requiring changes to how Django works (flow, not fight)
- Handle everything from the point of starting a purchase, until payment is complete.
- BYOPM, Bring Your Own Product Model.  Subclass your Product Model off of our base model and add whatever you want.  You are responsible for things like Catalogs and Presenting products to the user, we handle the purchasing of the products and generate a receipt you can look for.


## For Developers

*NOTE: It is reconmended that you first setup a virtual environment.*

To install the project, all you need to do is check out the project and run the following to install all the dependencies:

```bash
pip install -r requirements.txt
```

For developers, you'll need to also include a couple of dependencies that are only used in develop mode.  Run this from the root level of the project.

```bash
pip install -e .'[dev, authorizenet]'
```

To run the project, go into the develop folder:

To setup the models:

```bash
./manage.py migrate
```


Create the Super user

```bash
./manage.py createsuperuser
```


Then load the developer fixture if you want to pre-populate the cart & catalog

```bash
./manage.py loaddata developer
```

To run the project:

```bash
./manage.py runserver
```


to dump unit test data

```bash
./manage.py dumpdata --indent 4 auth.group --natural-foreign --natural-primary > fixtures/group.json
./manage.py dumpdata --indent 4 auth.user --natural-foreign > fixtures/user.json
./manage.py dumpdata --indent 4 -e contenttypes -e auth.permission -e sessions -e admin.logentry -e account.emailaddress -e auth.group -e auth.user > fixtures/unit_test.json
```



The install process
1) Add the app to your project
2) Create your Product model that inherits from the ProductModelBase base class.
3) Change the settings.py value for VENDOR_PRODUCT_MODEL to point to your model
4) Make migrations
5) Migrate


            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "django-vendor",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "django,app",
    "author": "Roberto Himmelbauer",
    "author_email": "Grant Viklund <renderbox@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/aa/de/d349ee313c9c6fd56024d04f0fcf36e7e1546d306f1a3609aeafe573cd12/django-vendor-0.4.13.tar.gz",
    "platform": null,
    "description": "![Django Vendor CI](https://github.com/renderbox/django-vendor/workflows/Django%20Vendor%20CI/badge.svg?branch=master)\n\n![Django Vendor Develop](https://github.com/renderbox/django-vendor/workflows/Django%20Vendor%20Develop/badge.svg?branch=develop)\n\n[![Documentation Status](https://readthedocs.org/projects/django-vendor/badge/?version=latest)](https://django-vendor.readthedocs.io/en/latest/?badge=latest)\n\n# Django Vendor\n\nDjango App Toolkit for selling digital and physical goods online.\n\nThe philosophy is \"Cart to Receipt\".  What you put in the cart and what you do after the purchase is up to you.  The app is opinionated within scope.\n\nGoals of the project:\n- Drop in to existing Django Sites without requiring changes to how Django works (flow, not fight)\n- Handle everything from the point of starting a purchase, until payment is complete.\n- BYOPM, Bring Your Own Product Model.  Subclass your Product Model off of our base model and add whatever you want.  You are responsible for things like Catalogs and Presenting products to the user, we handle the purchasing of the products and generate a receipt you can look for.\n\n\n## For Developers\n\n*NOTE: It is reconmended that you first setup a virtual environment.*\n\nTo install the project, all you need to do is check out the project and run the following to install all the dependencies:\n\n```bash\npip install -r requirements.txt\n```\n\nFor developers, you'll need to also include a couple of dependencies that are only used in develop mode.  Run this from the root level of the project.\n\n```bash\npip install -e .'[dev, authorizenet]'\n```\n\nTo run the project, go into the develop folder:\n\nTo setup the models:\n\n```bash\n./manage.py migrate\n```\n\n\nCreate the Super user\n\n```bash\n./manage.py createsuperuser\n```\n\n\nThen load the developer fixture if you want to pre-populate the cart & catalog\n\n```bash\n./manage.py loaddata developer\n```\n\nTo run the project:\n\n```bash\n./manage.py runserver\n```\n\n\nto dump unit test data\n\n```bash\n./manage.py dumpdata --indent 4 auth.group --natural-foreign --natural-primary > fixtures/group.json\n./manage.py dumpdata --indent 4 auth.user --natural-foreign > fixtures/user.json\n./manage.py dumpdata --indent 4 -e contenttypes -e auth.permission -e sessions -e admin.logentry -e account.emailaddress -e auth.group -e auth.user > fixtures/unit_test.json\n```\n\n\n\nThe install process\n1) Add the app to your project\n2) Create your Product model that inherits from the ProductModelBase base class.\n3) Change the settings.py value for VENDOR_PRODUCT_MODEL to point to your model\n4) Make migrations\n5) Migrate\n\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Django App Toolkit for selling digital and physical goods online.",
    "version": "0.4.13",
    "project_urls": {
        "Bug Tracker": "https://github.com/renderbox/django-vendor/issues",
        "Homepage": "https://github.com/renderbox/django-vendor"
    },
    "split_keywords": [
        "django",
        "app"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d85c7731e2f80bc87604f91238fe22452f00dc4c4140001a7b44228744864792",
                "md5": "bc36458cda1aa1e159d3c130fbd722b4",
                "sha256": "8a120d50df7764a7961444cceaf8323fa4e2fb6d5e9b1b2d82594c55e7af1084"
            },
            "downloads": -1,
            "filename": "django_vendor-0.4.13-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "bc36458cda1aa1e159d3c130fbd722b4",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": ">=3.7",
            "size": 196044,
            "upload_time": "2024-01-20T02:53:17",
            "upload_time_iso_8601": "2024-01-20T02:53:17.172702Z",
            "url": "https://files.pythonhosted.org/packages/d8/5c/7731e2f80bc87604f91238fe22452f00dc4c4140001a7b44228744864792/django_vendor-0.4.13-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "aaded349ee313c9c6fd56024d04f0fcf36e7e1546d306f1a3609aeafe573cd12",
                "md5": "2af5b5ad951cddf088c831500752f626",
                "sha256": "fa9c7a49bdca12f7c96f45a0b02c29cba5abb00e833cef71817a49f56ececb7c"
            },
            "downloads": -1,
            "filename": "django-vendor-0.4.13.tar.gz",
            "has_sig": false,
            "md5_digest": "2af5b5ad951cddf088c831500752f626",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 135031,
            "upload_time": "2024-01-20T02:53:19",
            "upload_time_iso_8601": "2024-01-20T02:53:19.784294Z",
            "url": "https://files.pythonhosted.org/packages/aa/de/d349ee313c9c6fd56024d04f0fcf36e7e1546d306f1a3609aeafe573cd12/django-vendor-0.4.13.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-01-20 02:53:19",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "renderbox",
    "github_project": "django-vendor",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "django-vendor"
}
        
Elapsed time: 0.18110s