flask-shopify-utils 0.2.8

A Flask extension for Shopify app development

Flask-Shopify-Utils

The utils for Flask Application that build for Shopify Custom App

---

Installing

$pip install -U flask-shopify-utils

Get the sample code to start

After install the "flask-shopify-utils", you should get the sample code by running the following command.

$lazy-dog

---

Example / How to ...

Please check the example folder for more details.

Remember, this package is using Flask-SQLAlchemy, so you need to initialize the database first.

from flask import Flask
from flask_sqlalchemy import SQLAlchemy
from flask_shopify_utils import ShopifyUtil

app = Flask(__name__)
# Init Database
db = SQLAlchemy()
db.init_app(app)

# Initial Shopify Utils
utils = ShopifyUtil()
utils.init_app(app)

# example: register default routes
utils.enroll_default_route()

---

Donate

Well, I have no idea how this work, just copy it from somewhere.

The Pallets organization develops and supports Flask and the libraries it uses. In order to grow the community of contributors and users, and allow the maintainers to devote more time to the projects, please donate today

---

First time setup

• Download the repository to your local machine.
• Create a virtualenv.

# Linux/macOS
$ python3 -m venv env
$ . env/bin/active

# Window
$ py -3 -m venv env
$ env/Scripts/active

• Install pip-tools, twine and build in the virtualenv.

>pip install --upgrade pip
>pip install pip-tools twine build

• Install the development dependencies, then install Flask-ShopifyUtils in editable mode.

$ pip install -r requirements/dev.txt && pip install -e .

• Build the wheel

# new 
>python -m build
# For more reference https://blog.ganssle.io/articles/2021/10/setup-py-deprecated.html

• Deploy to PyPI

# check
>twine check dist/*
# upload
>twine upload dist/* --skip-existing

requirements.txt

All dependencies are managed by pip-tools, so you need to install it first. And you can find them from the requirements folder.

# development
>pip-compile --extra=dev --output-file=requirements/dev.txt pyproject.toml

# production
>pip-compile --output-file=requirements/index.txt pyproject.toml

Check the code format

>flake8

Running the tests

Make sure you had installed the repository locally.

# install the package
>pip install -e .
# install the pytest
>pip install pytest
# run all tests
>pytest
# run tests with output
>pytest -s
# run specific test
>pytest -vs tests/test_init.py
# run specific test case
>pytest -vs tests/test_init.py::test_init_app

---

Reference

Packing for Python

TODO

[] - Optimize the get_version for "unstable" [] - Add CLI for "query_shopify_functions" [] - Add test for ShopifyUtil methods [] - Optimize the Graphql fetch method (don't raise exception) [] - Can I create the abs base class? for 'utils/base.py'