Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Shopify/shopify_django_app
Get a Shopify app up and running with Django and Python Shopify API
https://github.com/Shopify/shopify_django_app
Last synced: 5 days ago
JSON representation
Get a Shopify app up and running with Django and Python Shopify API
- Host: GitHub
- URL: https://github.com/Shopify/shopify_django_app
- Owner: Shopify
- License: mit
- Created: 2011-08-30T19:35:19.000Z (about 13 years ago)
- Default Branch: master
- Last Pushed: 2024-05-04T01:32:21.000Z (6 months ago)
- Last Synced: 2024-11-03T14:35:53.323Z (11 days ago)
- Language: Python
- Homepage:
- Size: 91.8 KB
- Stars: 469
- Watchers: 504
- Forks: 157
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- shopify-development-resources - Shopify Example Django App
- jimsghstars - Shopify/shopify_django_app - Get a Shopify app up and running with Django and Python Shopify API (Python)
README
Shopify Django App Example
==========================
This project makes it easy to get a Shopify app up and running with
[Django](https://www.djangoproject.com/) and the
[Python Shopify API](https://github.com/shopify/shopify_python_api).
This project simply displays basic information about the shop's products
and orders.
This project has the following structure
- `shopify_app` an app which handles authentication (meant to be reusable)
- `home` an app which contains the example code to demonstrate how to use the API (meant to be modified or replaced to create your Shopify App).
- `shopify_django_app` project files for serving this app.
Get It Running
--------------
### Create Your App Configuration
- Log in to your [partners dashboard](https://partners.shopify.com/)
- Navigate to [your apps](https://partners.shopify.com/current/apps)
- Click `Create App`
- Choose a custom app or public app
- Fill in the app name
- Set the Application Url http://localhost:8000/
- Set Whitelisted redirection URL( http://localhost:8000/shopify/finalize/
You will then have access to your API key and API secret KEY, you will need these
for the next steps.
### Setup Environment
1. Copy over the `.env.local` file into a `.env` file and fill out the `SHOPIFY_API_KEY` and `SHOPIFY_API_SECRET` fields
```
cp .env.local .env
```
2. Generate a secret key and add it to `.env` by running the following in the command line:
```
python -c 'import random; print("".join([random.choice("abcdefghijklmnopqrstuvwxyz0123456789!@#$%^&*(-_=+)") for i in range(50)]))' >> .env
```
**For PC Users:** Run this command in [GIT Bash](https://git-scm.com/) or [Windows Subsystem For Linux](https://docs.microsoft.com/en-us/windows/wsl/install-win10). Alternatively, you can generate a secret key using the Python interpreter. This requires you to manually add the Django secret key to your `.env` file by doing the following:
Open the python interpreter:
```
python
```
Inside the python interpreter, generate the secret key, copy it, and exit:
```python
>>> import random
>>> print("".join([random.choice("abcdefghijklmnopqrstuvwxyz0123456789!@#$%^&*(-_=+)") for i in range(50)]))
>>> exit()
```
3. [Optional] you can add the api version and api scopes environment variables to the `.env` file:
* `SHOPIFY_API_VERSION` default is `unstable`
* `SHOPIFY_API_SCOPE` a comma-separated list of scopes, default is `read_products,read_orders`
### Run the App
We use [pipenv](https://github.com/pypa/pipenv) to get running faster. With the
`.env` already created in the root directory, run the app:
```
pipenv install
pipenv run python manage.py migrate
pipenv run python manage.py runserver
```
Open in your browser to view the example.