Skip to content
/ myte Public

A versatile command-line tool designed to streamline your web development process in Python.

License

Notifications You must be signed in to change notification settings

samdoghor/myte

Repository files navigation

Myte Documentation

Python web framework boilerplate made easy (Start your projects in seconds)

Last commit GitHub Release GitHub License PyPI - Version PyPI - Python Version

Myte allows users to choose from popular web frameworks like Flask, FastAPI, and Tornado when initializing a new project. After entering a project name, the user selects their preferred framework which then generates the basic directory structure and boilerplate code to get started.

The project is still at it early phase, alot of expected features are missing.

Why you should use Myte

Choose Myte for effortless web development setup. With intuitive project initialization, pick your preferred framework like Flask or anticipate upcoming options like FastAPI. Whether you're a seasoned developer or just starting out, Myte's user-friendly interface guides you smoothly through setup. Customize project structures to fit your needs with adaptable templates. Stay ahead of the curve with ongoing updates and enhancements, making your web development journey seamless and exciting.

Features

  • πŸš€ Project Bootstrapping
  • πŸ’‘ Simplified project setup
  • πŸ› οΈ Framework flexibility
  • πŸ“ Customizable templates
  • πŸ’» Cross-OS functionality

Supported frameworks

Framework Status
Flask βœ… Completed
FastAPI πŸ› οΈ Undergoing Development
Tornado ❌ Not started
Bottle ❌ Not started
Pyramid ❌ Not started
CherryPy ❌ Not started

Installing

It is recommended to Install Myte without a virtual environment so it would be available to bootstrap all your web projects going forward.

Install and update using pip

pip install myte

or

python3 -m pip install myte

Usage

Run the code below to get started

create-myte

How it looks after 4 simple steps

"Step 1"

`$ create-myte` 

Enter the value y to proceed or N to terminate the program

    Compatible Note:
    Myte requires at least Python 3.8. However, the tool may still work
    fine in lower versions. If you encounter any error, do well to report
    them here <https://cutt.ly/1wSR7LW0>
    Thank you

    Do you want to continue? [y/N]: `y`

"Step 2"

Enter your desired project name or simply enter . (this will erase everything in the current folder) to use current folder.

    Project Name (myte-project):

    βœ… Project name: myte-project

"Step 3"

Use the up and down arrow key to select from the available framework and hit enter.

    [?] Select a framework: Flask
    > Flask
    Flask-Restful-API

    βœ… Flask,  selected

"Step 4"

Use the up and down arrow key to select from the available complexity and hit enter.

    [?] Select complexity: Simple
    > Simple
    Robust

    βœ… Simple,  selected

    Project setup complete

    Usage:
    Run the commands below:

    - cd myte-project
    -> Your OS is Windows
    - pip install virtualenv (if not installed)
    - virtualenv env
    - source env/scripts/activate
    - pip install -r requirements.txt
    - Rename example.env to .env
    - Go to config.py, decide the database you want to use, uncomment it
    and run the pip instructions there
    - Go to .env, replace 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' in SECRETKEY with -> og3dOuRYNcnItH2XbYHMYHffbMcBxsS0

Contribution

See Contributing Guide.

License

MIT.