shopyo / shopyo Goto Github PK

View Code? Open in Web Editor NEW

73.0 4.0 27.0 16.17 MB

The package for big, scalable and modular Flask apps. More than just Flask boilerplate

Home Page: https://shopyo.readthedocs.org

License: Other

Python 84.42% HTML 13.67% CSS 1.49% JavaScript 0.42%

flask javascript fullstack python python3 django shopyo modules first-timers-friendly module

shopyo's Introduction

Featured on Weekly Python issue 436 🌟

A 45 mins talk was dedicated to it at EuroPython 🌟

Must watch: Shopyo: Your Mega Flask Machine (short vid)

E-commerce modules transferred to ShopCube

[ DOCS | DISCORD | CONTRIBUTE | TWITTER]

What?

Your next-level modular web framework. Get organisation & scalability from day 1.

Built on top of Flask, it offers most Django features, sometimes a tidbit more with far more flexibility.

Why?

Perk
🥏 No learning	Does not get into the way, uses common flask-packages. You only need to know Flask.
🏗️ Architecture	Never think about architecture of your app, just build & integrate extensions.
🏢 Scalable	As your app grows, Shopyo caters for your codebase with powerful features.
🥢 Good practices	Testing, docs etc are covered. Don't make those afterthoughts.
🔧 Ease your life	We've been there. Awesome utils to ease development.
🪜 Scaffolding	Don't waste time writing boilerplate code. We've got you covered.
🖍️ Theming system	You need theme in your apps? We integrate a default theme system.

Features

⚛️ i18n setup
🔐 Login & Auth
📧 Email
📦 2-level modularity
🪐 Designed for really BIG apps
🌅 Assets management

Quick start

pip install shopyo==4.9.3
mkdir blog
cd blog
shopyo new -m # add default modules
cd blog
shopyo initialise
flask run --debug

pip install shopyo==4.9.3
mkdir blog
cd blog
shopyo new
cd blog
flask run --debug

If errors do (linux, use set <VAR> for Windows):

export SHOPYO_CONFIG_PROFILE=development
export FLASK_ENV=development # < flask 2.2.x
export ENV=development
export FLASK_DEBUG=development # < flask 2.2.x
export FLASK_APP=app.py

SHOPYO_CONFIG_PROFILE is what is defined as keys of app_config in config.py

It is recommended to use a venv in root folder.

python -m venv venv

If for dev install dev_requirements.txt also.

python -m pip install -r requirements/dev.txt

go to http://127.0.0.1:5000/dashboard with credentials [email protected] / pass

Not framework docs but docs for the project you are building.

First time contributing?

We have a 100% first-timers friendly policy. Check out the testimonials.

Thank you! One of the best onboarding experiences I've had. Learned a lot too (Ramon from Codesee.io)

Glimpse

Who uses Shopyo?

site name	description
Maurilearn.com	Elearning platform
Linkolearn.com	Learn By links
FlaskCon.com	Conference soft

Big??

Apps are not enough, organise them in boxes and get the ultimate order you need.

You need a customised Django? This is the project. You need to build an ERP? This is the project.

Linux??

Hackable to the core. Even the dashboard is but a module.

Don't need our modules? Nuke them. Look boring? modify them

Reliable?

We don't maintain middlewares. We rely on battle tested batteries like:

flask_sqlalchemy
flask_login & co

Heck remove them if you don't want. Want to use Peewee? You can.

Rich Flask API

Common flask patterns are integrated, the structure is over the moon.

Common flask tasks are provided with an API: custom notifications, bulk form errors

Back office feel & Theme

All looks are 100% customisable with themes ~ Backend, bootstrap included by default.

Again blow it up & use what you want. It's possible

Transparent: Code your own web distro

Everything is clear, not hidden. You can 100% customise whatever you want.

We did not hardcode our choices. Our APIS are incremental. You can always use barebones.

Plug & Play

The modules are put by copy paste. No blueprint codes to write.

Contribute

We follow a 100% first-timers friendly policy.

👉 Get started here

👉 Join the Discord, ask questions & learn about Flask tricks during our dev talks!

📚 Docs

👉 Link: shopyo.readthedocs.io/

📞 Contact (inlcuding in case of vulns)

Support team if you are stuck

shopyo's People

Contributors

Stargazers

Watchers

shopyo's Issues

ENHANCE: move email.py from auth module to API

DOCS: fix the setup instructions login link

Fix step 13 of Setup Instructions section in contrib.rst by changing http://localhost:5000/login/ to http://localhost:5000/auth/login

DOCS: add typing where possible and add `mypy` check

DOCS: Add createmodule examples

DOCS: update setup instructions for the new repo

BUG: startbox creates box without box__ prefix

FEAT: update the code so it works for latest pallets releases

ENHANCE: init.py attributes to modules

DOCS: add upgrade setuptools to shared hosting guide

FIX: replace `rundebug/runserver` `shopyo_cli` commands hack with click commands

Replace the shopyo_cli() function from shopyo/shopyo/api/cli.py with two separate click command as explained below:

For rundebug:

@cli.command("rundebug", with_appcontext=False)
def rundebug():
    """runs the shopyo flask app in development mode"""
    app_path = os.path.join(os.getcwd(), "app.py")

    if not os.path.exists(app_path):
        click.secho(f"Unable to find `app.py` in {os.getcwd()}", fg="red")
        sys.exit(1)

    os.environ["FLASK_APP"] = "app:create_app('development')"
    os.environ["FLASK_ENV"] = "development"
    run(["flask", "run"])

For runserver, do the same as above but change development to production and set command name to runserver
replace shopyo_cli with cli in both /shopyo/shopyo/api/cli.py and shopyo/shopyo/manage.py

To test, run shopyo rundebug and shopyo runserver in shopyo/shopyo directory and go to http://127.0.0.1:5000/

Before starting this issue, make sure you have setup the repo as explained in the docs here

ENHANCE: Add option copy default modules in already created project

CHORE: Don't pin exact library in `requirements.txt`. Put >= x or <= x

FEAT: change new command to use shopyo-factory

REVERT: use `startapp` as before instead of `createmodule` to be same as Django

startapp was the command, create module was the internal function, need to just readd it

DOCS: start updating changelog

ENHANCE: Prune default modules to include only enhanced auth in box__default

DOCS: Add flask-restx integration section

ENHANCE: box__default use ModuleHelp from shopyo.api.module intead of manual blueprint config

ENHANCE: Remove theme and static if not using -m

ENHANCE: Audit check for url_prefix conflicts

REFACTOR: move all github images to assets folder

move banner, other images etch to a new assets folder

Bug: all functions in `enhance.py` outside `api` so that it is available in cookiecutter

BUG: update README instruction for install dev requirements

Change python -m pip install -r dev_requirements.txt to python -m pip install -r requirements/dev.txt in REAMDE.md under the heading https://github.com/shopyo/shopyo#have-a-go

WARNING: default modules access must be fixed

This affects the DEFAULT application stack.

When someone registers for an account and is UNCONFIRMED they can reach and manipulate the data. The following URLs are affected.

/appadmin
/appointment
/people
/theme
/resource

FIRST_TIMERS_ONLY: Remove line in README

Remove this line from the README:

It ships with common business needs by default

DOCS: update make a PR request instructions

Remove the steps 6, 7, 8. Improve the other steps for example mention about tox, pre-commit etc

REFACTOR: remove all unused files.

docker-compose.yml (not using but will configure later so remove it)
.travis.yml (unlikely to use it again since it's not free)
.nojekyll (since we are using readthedoc remove this. Can add again if we use github.io)
Dockerfile (not setup correctly so might as well remove. Will later add this)
shopyo/setup.cfg (should be only in root)
shopyo/pyproject.toml (should be only in root)
shopyo/file.py (added there by mistake)
chromedriver (will add once we setup up frontend tests)
shopyo/shopyo/tests/frontend_tst.py (not tested probably using very old code. Will add this file once frontend tests are added)

@Abdur-rahmaanJ in case you want to keep any, or if I missed any feel free to add/update

BUG: PR #8 overwrote the changes made in PR #10

#8 changes were incorrectly merge to dev

DOCS: Add celery integration section

Bug: setting .flaskenv raises ModuleNotFoundError: No module named 'modules'

See Abdur-rahmaanJ/shopcube#481.

DOCS: change clone link to SSH

Add filtering options to the audit command

shopyo audit generates something like this:

Running audit ...
Checking apps ...
/home/appinv/code/shopyo/shopyo/modules/www
    warning: global.py not found

/home/appinv/code/shopyo/shopyo/modules/resource
    warning: global.py not found

/home/appinv/code/shopyo/shopyo/modules/box__default
    /home/appinv/code/shopyo/shopyo/modules/box__default/settings
        warning: forms.py not found
        warning: global.py not found
    /home/appinv/code/shopyo/shopyo/modules/box__default/dashboard
        warning: forms.py not found
        warning: models.py not found
        warning: global.py not found
    /home/appinv/code/shopyo/shopyo/modules/box__default/auth
        warning: global.py not found
    /home/appinv/code/shopyo/shopyo/modules/box__default/appadmin
        warning: forms.py not found
        warning: global.py not found
    /home/appinv/code/shopyo/shopyo/modules/box__default/base
        warning: forms.py not found
        warning: models.py not found
        warning: global.py not found
    /home/appinv/code/shopyo/shopyo/modules/box__default/theme

/home/appinv/code/shopyo/shopyo/modules/box__bizhelp
    /home/appinv/code/shopyo/shopyo/modules/box__bizhelp/people
        warning: forms.py not found
        warning: global.py not found
    /home/appinv/code/shopyo/shopyo/modules/box__bizhelp/appointment
        warning: forms.py not found
        warning: global.py not found
    /home/appinv/code/shopyo/shopyo/modules/box__bizhelp/contact
    /home/appinv/code/shopyo/shopyo/modules/box__bizhelp/page
        warning: global.py not found

Audit finished!

The command is defined here with the audit here.

It is cumbersome to view all warnings. We can add flags to filter warnings by severe like --show severe,warning

Task: Add flags to filter warnings. Feel free to modify the code!

FEAT: Change "site under construction" to something nice!

DOCS: add more setup instructions if using ubuntu/linux

Example: add a note about sudo apt install python3-venv in the setup instructions if venv is not installed

FEAT: Shopyo packages

Design a plugins system for Shopyo which will

load apps when packaged as a module
load boxes when packaged as a module

This means loading blueprints, templates and collecting static assets.

In sum, it means that installed shopyo packages must work as well as they work in modules/

We'll have a Google meet to better explain the issue.

I have a base to get started with, needs more discussion.

Requirements

Know Flask API for extension development (will help)
Know Python packaging (knowledge of entry point for developing plugin system is a bonus)

or is a Flask user for some 4 - 5 years

Appreciation

$100 in btc

Currently my time is a bit limited and i appreciate anybody helping out. Since this is a core milestone of the project, i want someone nice to implement it. I tried putting this on bounty source but i cannot set up Metamask. So i'll be transferring it once the issue is closed. I am willing to answer any question.

How to apply?

Drop a comment: Interested then join the discord server. We'll then have a Google meet. If you are still interested, then we'll continue.

shopyo new .

so that steps are

create projectfolder
create and activate venv
install shopyo
shopyo new . does not create additional folders

proj/
    shopyo/

Rationale

So that migrations ignored else user will have to manually edit .gitignore

BUG: Tests failing & install due to new releases 2.0 of Flask & Co

BUG: `python manage.py initilaise` not working

Only python manage.py rundebug or python manage.py runserver works nothing else.

Source of problem:

# manage.py
def shopyo_cli():
    arguments = sys.argv[1:]
    if len(arguments) > 0:
        print(arguments)
        if arguments[0] in ['rundebug', 'runserver']:
            if arguments[0] == 'rundebug':
                printinfo()
                from app import app
                app.run(debug=True)
            elif arguments[0] == 'runserver':
                printinfo()
                from app import app
                app.run(debug=False)
    else:
        cli()

Potential fix: Indent the last else to one more place so it becomes:

    if len(arguments) > 0:
        print(arguments)
        if arguments[0] in ['rundebug', 'runserver']:
            if arguments[0] == 'rundebug':
                printinfo()
                from app import app
                app.run(debug=True)
            elif arguments[0] == 'runserver':
                printinfo()
                from app import app
                app.run(debug=False)
        else:
            cli()