| Name | Myte JSON |
| Version |
0.2.0
JSON |
| download |
| home_page | |
| Summary | Myte allows users to choose from popular web frameworks like Flask, FastAPI, and Tornado etc 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. |
| upload_time | 2024-03-13 18:36:57 |
| maintainer | |
| docs_url | None |
| author | Samuel Doghor |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2023 Samuel Doghor Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
myte
flask
fastapi
tornado
bottle
pyramid
cherrypy
boilerplate
web framework
project bootstrapping
framework
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
ansicon
blessed
build
certifi
charset-normalizer
click
colorama
distlib
docutils
editor
filelock
flake8
gitdb
idna
importlib-metadata
inquirer
isort
jaraco.classes
jinxed
keyring
markdown-it-py
mccabe
mdurl
more-itertools
nh3
packaging
pipenv
pkginfo
platformdirs
pycodestyle
pyflakes
Pygments
pyproject_hooks
python-editor
pywin32-ctypes
readchar
readme-renderer
requests
requests-toolbelt
rfc3986
rich
runs
shellingham
six
smmap
twine
typer
typing_extensions
urllib3
virtualenv
wcwidth
xmod
zipp
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Myte Documentation
Python web framework boilerplate made easy (`Start your projects in seconds`)
    
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](https://flask.palletsprojects.com/) | ✅ Completed |
| [FastAPI](https://fastapi.tiangolo.com/) | 🛠️ Undergoing Development |
| [Tornado](https://www.tornadoweb.org/en/stable/) | ❌ Not started |
| [Bottle](https://bottlepy.org/) | ❌ Not started |
| [Pyramid](https://trypyramid.com/) | ❌ Not started |
| [CherryPy](https://docs.cherrypy.dev/en/latest/) | ❌ 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](https://pip.pypa.io/en/stable/getting-started/)
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](CONTRIBUTING.md).
## License
[MIT](LICENSE).
Raw data
{
"_id": null,
"home_page": "",
"name": "Myte",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "Myte,Flask,FastAPI,Tornado,Bottle,Pyramid,CherryPy,Boilerplate,Web framework,Project bootstrapping,Framework",
"author": "Samuel Doghor",
"author_email": "Samuel Doghor <talkto@samdoghor.com>",
"download_url": "https://files.pythonhosted.org/packages/f1/e5/c258502f84a7f1ea2ab5aa6d56cbeaf2a2643abda0d6e87a2dbf3ececf0e/Myte-0.2.0.tar.gz",
"platform": null,
"description": "# Myte Documentation\r\n\r\nPython web framework boilerplate made easy (`Start your projects in seconds`)\r\n\r\n    \r\n\r\nMyte 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.\r\n\r\n The project is still at it early phase, alot of expected features are missing.\r\n\r\n## Why you should use Myte\r\n\r\nChoose 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.\r\n\r\n## Features\r\n\r\n- \ud83d\ude80 Project Bootstrapping\r\n- \ud83d\udca1 Simplified project setup\r\n- \ud83d\udee0\ufe0f Framework flexibility\r\n- \ud83d\udcdd Customizable templates\r\n- \ud83d\udcbb Cross-OS functionality\r\n\r\n## Supported frameworks\r\n\r\n| Framework | Status |\r\n| --------------- | --------------- |\r\n| [Flask](https://flask.palletsprojects.com/) | \u2705 Completed |\r\n| [FastAPI](https://fastapi.tiangolo.com/) | \ud83d\udee0\ufe0f Undergoing Development |\r\n| [Tornado](https://www.tornadoweb.org/en/stable/) | \u274c Not started |\r\n| [Bottle](https://bottlepy.org/) | \u274c Not started |\r\n| [Pyramid](https://trypyramid.com/) | \u274c Not started |\r\n| [CherryPy](https://docs.cherrypy.dev/en/latest/) | \u274c Not started |\r\n\r\n## Installing\r\n\r\n It is `recommended` to Install `Myte` without a virtual environment so it would be available to bootstrap all your web projects going forward.\r\n\r\nInstall and update using [pip](https://pip.pypa.io/en/stable/getting-started/)\r\n\r\n pip install myte\r\n\r\nor\r\n\r\n python3 -m pip install myte\r\n\r\n## Usage\r\n\r\nRun the code below to get started\r\n\r\n create-myte\r\n\r\n### How it looks after 4 simple steps\r\n\r\n#### \"Step 1\"\r\n\r\n `$ create-myte` \r\n\r\n Enter the value `y` to proceed or `N` to terminate the program\r\n\r\n Compatible Note:\r\n Myte requires at least Python 3.8. However, the tool may still work\r\n fine in lower versions. If you encounter any error, do well to report\r\n them here <https://cutt.ly/1wSR7LW0>\r\n Thank you\r\n\r\n Do you want to continue? [y/N]: `y`\r\n\r\n#### \"Step 2\"\r\n\r\n Enter your `desired project name` or simply enter `.` (this will erase everything in the current folder) to use current folder.\r\n\r\n Project Name (myte-project):\r\n\r\n \u2705 Project name: myte-project\r\n\r\n#### \"Step 3\"\r\n\r\n Use the `up` and `down` `arrow key` to select from the available framework and hit `enter`.\r\n\r\n [?] Select a framework: Flask\r\n > Flask\r\n Flask-Restful-API\r\n\r\n \u2705 Flask, selected\r\n\r\n#### \"Step 4\"\r\n\r\n Use the `up` and `down` `arrow key` to select from the available complexity and hit `enter`.\r\n\r\n [?] Select complexity: Simple\r\n > Simple\r\n Robust\r\n\r\n \u2705 Simple, selected\r\n\r\n Project setup complete\r\n\r\n Usage:\r\n Run the commands below:\r\n\r\n - cd myte-project\r\n -> Your OS is Windows\r\n - pip install virtualenv (if not installed)\r\n - virtualenv env\r\n - source env/scripts/activate\r\n - pip install -r requirements.txt\r\n - Rename example.env to .env\r\n - Go to config.py, decide the database you want to use, uncomment it\r\n and run the pip instructions there\r\n - Go to .env, replace 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' in SECRETKEY with -> og3dOuRYNcnItH2XbYHMYHffbMcBxsS0\r\n\r\n## Contribution\r\n\r\nSee [Contributing Guide](CONTRIBUTING.md).\r\n\r\n## License\r\n\r\n[MIT](LICENSE).\r\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 Samuel Doghor Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Myte allows users to choose from popular web frameworks like Flask, FastAPI, and Tornado etc 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.",
"version": "0.2.0",
"project_urls": {
"Changelog": "https://github.com/samdoghor/myte/blob/main/CHANGELOG.md",
"Homepage": "https://github.com/samdoghor/myte",
"Issues": "https://github.com/samdoghor/myte/issues"
},
"split_keywords": [
"myte",
"flask",
"fastapi",
"tornado",
"bottle",
"pyramid",
"cherrypy",
"boilerplate",
"web framework",
"project bootstrapping",
"framework"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bbfce7b202b0b04b0a8d2dd5b7e9468448f3161fb664b235705e1897d11bb228",
"md5": "96558eb67bc5d86280ae17e1f5fd6fe7",
"sha256": "9dce229a5b9487da736a2ad34ec4277a2ede0bc267737e0c04b1dbd9e6145d81"
},
"downloads": -1,
"filename": "Myte-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "96558eb67bc5d86280ae17e1f5fd6fe7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 400541,
"upload_time": "2024-03-13T18:36:54",
"upload_time_iso_8601": "2024-03-13T18:36:54.297058Z",
"url": "https://files.pythonhosted.org/packages/bb/fc/e7b202b0b04b0a8d2dd5b7e9468448f3161fb664b235705e1897d11bb228/Myte-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f1e5c258502f84a7f1ea2ab5aa6d56cbeaf2a2643abda0d6e87a2dbf3ececf0e",
"md5": "b65e41eeac9945ce0db0ad4c2904ecbb",
"sha256": "92bfaaebcdabce3fdcb9bccbfb892b33dc0285b08542cbd6cdb6a29ca6cbf8b6"
},
"downloads": -1,
"filename": "Myte-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "b65e41eeac9945ce0db0ad4c2904ecbb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 278373,
"upload_time": "2024-03-13T18:36:57",
"upload_time_iso_8601": "2024-03-13T18:36:57.241621Z",
"url": "https://files.pythonhosted.org/packages/f1/e5/c258502f84a7f1ea2ab5aa6d56cbeaf2a2643abda0d6e87a2dbf3ececf0e/Myte-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-13 18:36:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "samdoghor",
"github_project": "myte",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "ansicon",
"specs": [
[
"==",
"1.89.0"
]
]
},
{
"name": "blessed",
"specs": [
[
"==",
"1.20.0"
]
]
},
{
"name": "build",
"specs": [
[
"==",
"1.0.3"
]
]
},
{
"name": "certifi",
"specs": [
[
"==",
"2023.7.22"
]
]
},
{
"name": "charset-normalizer",
"specs": [
[
"==",
"3.3.2"
]
]
},
{
"name": "click",
"specs": [
[
"==",
"8.1.7"
]
]
},
{
"name": "colorama",
"specs": [
[
"==",
"0.4.6"
]
]
},
{
"name": "distlib",
"specs": [
[
"==",
"0.3.7"
]
]
},
{
"name": "docutils",
"specs": [
[
"==",
"0.20.1"
]
]
},
{
"name": "editor",
"specs": [
[
"==",
"1.6.5"
]
]
},
{
"name": "filelock",
"specs": [
[
"==",
"3.12.4"
]
]
},
{
"name": "flake8",
"specs": [
[
"==",
"7.0.0"
]
]
},
{
"name": "gitdb",
"specs": [
[
"==",
"4.0.11"
]
]
},
{
"name": "idna",
"specs": [
[
"==",
"3.6"
]
]
},
{
"name": "importlib-metadata",
"specs": [
[
"==",
"7.0.1"
]
]
},
{
"name": "inquirer",
"specs": [
[
"==",
"3.2.1"
]
]
},
{
"name": "isort",
"specs": [
[
"==",
"5.13.2"
]
]
},
{
"name": "jaraco.classes",
"specs": [
[
"==",
"3.3.0"
]
]
},
{
"name": "jinxed",
"specs": [
[
"==",
"1.2.1"
]
]
},
{
"name": "keyring",
"specs": [
[
"==",
"24.3.0"
]
]
},
{
"name": "markdown-it-py",
"specs": [
[
"==",
"3.0.0"
]
]
},
{
"name": "mccabe",
"specs": [
[
"==",
"0.7.0"
]
]
},
{
"name": "mdurl",
"specs": [
[
"==",
"0.1.2"
]
]
},
{
"name": "more-itertools",
"specs": [
[
"==",
"10.2.0"
]
]
},
{
"name": "nh3",
"specs": [
[
"==",
"0.2.15"
]
]
},
{
"name": "packaging",
"specs": [
[
"==",
"23.2"
]
]
},
{
"name": "pipenv",
"specs": [
[
"==",
"2023.9.8"
]
]
},
{
"name": "pkginfo",
"specs": [
[
"==",
"1.9.6"
]
]
},
{
"name": "platformdirs",
"specs": [
[
"==",
"3.11.0"
]
]
},
{
"name": "pycodestyle",
"specs": [
[
"==",
"2.11.1"
]
]
},
{
"name": "pyflakes",
"specs": [
[
"==",
"3.2.0"
]
]
},
{
"name": "Pygments",
"specs": [
[
"==",
"2.17.2"
]
]
},
{
"name": "pyproject_hooks",
"specs": [
[
"==",
"1.0.0"
]
]
},
{
"name": "python-editor",
"specs": [
[
"==",
"1.0.4"
]
]
},
{
"name": "pywin32-ctypes",
"specs": [
[
"==",
"0.2.2"
]
]
},
{
"name": "readchar",
"specs": [
[
"==",
"4.0.5"
]
]
},
{
"name": "readme-renderer",
"specs": [
[
"==",
"42.0"
]
]
},
{
"name": "requests",
"specs": [
[
"==",
"2.31.0"
]
]
},
{
"name": "requests-toolbelt",
"specs": [
[
"==",
"1.0.0"
]
]
},
{
"name": "rfc3986",
"specs": [
[
"==",
"2.0.0"
]
]
},
{
"name": "rich",
"specs": [
[
"==",
"13.7.0"
]
]
},
{
"name": "runs",
"specs": [
[
"==",
"1.2.0"
]
]
},
{
"name": "shellingham",
"specs": [
[
"==",
"1.5.4"
]
]
},
{
"name": "six",
"specs": [
[
"==",
"1.16.0"
]
]
},
{
"name": "smmap",
"specs": [
[
"==",
"5.0.1"
]
]
},
{
"name": "twine",
"specs": [
[
"==",
"4.0.2"
]
]
},
{
"name": "typer",
"specs": [
[
"==",
"0.9.0"
]
]
},
{
"name": "typing_extensions",
"specs": [
[
"==",
"4.9.0"
]
]
},
{
"name": "urllib3",
"specs": [
[
"==",
"2.1.0"
]
]
},
{
"name": "virtualenv",
"specs": [
[
"==",
"20.24.5"
]
]
},
{
"name": "wcwidth",
"specs": [
[
"==",
"0.2.13"
]
]
},
{
"name": "xmod",
"specs": [
[
"==",
"1.8.1"
]
]
},
{
"name": "zipp",
"specs": [
[
"==",
"3.17.0"
]
]
}
],
"lcname": "myte"
}
