| Name | sakyum JSON |
| Version |
0.0.12
JSON |
| download |
| home_page | https://sakyum.readthedocs.io |
| Summary | An extension of flask web framework that erase the complexity of structuring flask project blueprint, packages, and other annoying stuffs |
| upload_time | 2023-06-23 07:40:22 |
| maintainer | |
| docs_url | None |
| author | Usman Musa |
| requires_python | >=3.7 |
| license | MIT |
| keywords |
sakyum
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Sakyum
An extension of flask web framework that erase the complexity of structuring flask project blueprint, packages, and other annoying stuffs.
## Installation
Install and update the latest release from <a href="https://pypi.org/project/sakyum">pypi</a>. Basically the library was uploaded using `sdist` (Source Distribution) and `bdist_wheel` (Built Distribution), this software (library) as from `v0.0.9` it is compatible and also tested with `windows OS` and others as well, such as `linux`, `macOS` and possibly some others too!.
```
pip install --upgrade sakyum
```
## Create flask project using sakyum
After the installation paste the following command on your termianl
```
python -c "from sakyum import project; project('schoolsite')"
```
This will create a project called `schoolsite` now cd into the `schoolsite` directory, if you do `ls` within the directory you just enter you will see a module called `thunder.py` and some directories (some in the form of package) `media`, `static`, `templates` and a directory with the same name of your base directory name, in our case it is `schoolsite`.
Boot up the flask server by running the below command
```
python thunder.py boot
```
Now visit the local url `http://127.0.0.1:5000` this will show you index page of your project
## Create flask app within your project (schoolsite)
For you to start an app within your project `schoolsite` shutdown the flask development server by pressing ( CTRL+C ) and then run the following command, by giving the name you want your app to be, in our case we will call our app `exam`
```
python thunder.py create_app -a exam
```
this will create an app (a new package called `exam`) within your project `(schoolsite)`
## Register an app
Once the app is created open a file `schoolsite/routes.py` and import your `exam` blueprint which is in (`exam/views.py`), default name given to an app blueprint, is the app name so our `exam` app blueprint name is `exam`, after importing it, append (register) the app blueprint in a list called `reg_blueprints` in that same file of `schoolsite/routes.py`
importing blueprint
```py
from exam.views import exam
```
registering blueprint
```py
reg_blueprints = [
blueprint.default,
blueprint.errors,
blueprint.auth,
base,
exam,
]
```
once you register the app, boot up the flask webserver again by
```
python thunder.py boot
```
visit `http://127.0.0.1:5000` which is your project landing page
visit `http://127.0.0.1:5000/exam` this will take you to your app landing page (exam)
visit `http://127.0.0.1:5000/admin` this will take you to admin page. From there you are ready to go.
See more documentations <a href="https://sakyum.readthedocs.io">here!</a>
### Sakyum default page
[](https://sakyum.readthedocs.io)
## Useful links
- Documentation: https://sakyum.readthedocs.io
- Repository: https://github.com/usmanmusa1920/sakyum
- Docker example: https://github.com/usmanmusa1920/sakyum/tree/master/example/sakyum-docker
Pull requests are welcome
Change Log
==========
0.0.12 (23/june/2023)
------------------
- Twelveth Release
Testing for OS compatibility also again! again!! again!!!
- Eleventh Release
Testing for OS compatibility again! again!! again!!!
- Tenth Release
Testing for OS compatibility again
- Nineth Release
Fixing bugs
Fixing v0.0.8 bugs for OS compatibility, and also tested on windows OS
- Eight Release
OS compatibility
Making sakyum to be compatible with windows OS as well as other OS
- Seventh Release
This release mostly is for adding more docs and examples.
- Sixth Release
Alembic is included as dependency (in the require module list).
- Fifth Release
In fifith release, we handle how default user file system tricks is, things like when user change his profile picture.
- Fourth Release
In this release we handle how we can customise the admin html page by inheriting (extends) it in our project templates/admin directory, and the admin page on how to bind models in the admin. Also I refactor other libraries that this package needs with their corresponding versions in the setup.py and requirements.txt files. In this release good documentations is well packed.
Database migration is added using `alembic`
Some error pages, default page were added but still you can customise it in your project sub folder (the package with the same name of your project in your project directory) in a file called `route.py`. Also an admin directory within your project templates folder is added too!
Possibly other well things are added which include auth system for `users` and more.
Raw data
{
"_id": null,
"home_page": "https://sakyum.readthedocs.io",
"name": "sakyum",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "sakyum",
"author": "Usman Musa",
"author_email": "usmanmusa1920@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/02/f9/9a58ce5bfe08cb02cb778001e1fbe0e86523015f1d009217dbb203f700db/sakyum-0.0.12.tar.gz",
"platform": "any",
"description": "\n# Sakyum\n\nAn extension of flask web framework that erase the complexity of structuring flask project blueprint, packages, and other annoying stuffs.\n\n## Installation\n\nInstall and update the latest release from <a href=\"https://pypi.org/project/sakyum\">pypi</a>. Basically the library was uploaded using `sdist` (Source Distribution) and `bdist_wheel` (Built Distribution), this software (library) as from `v0.0.9` it is compatible and also tested with `windows OS` and others as well, such as `linux`, `macOS` and possibly some others too!.\n\n```\npip install --upgrade sakyum\n```\n\n## Create flask project using sakyum\n\nAfter the installation paste the following command on your termianl\n\n```\npython -c \"from sakyum import project; project('schoolsite')\"\n```\n\nThis will create a project called `schoolsite` now cd into the `schoolsite` directory, if you do `ls` within the directory you just enter you will see a module called `thunder.py` and some directories (some in the form of package) `media`, `static`, `templates` and a directory with the same name of your base directory name, in our case it is `schoolsite`.\n\nBoot up the flask server by running the below command\n\n```\npython thunder.py boot\n```\n\nNow visit the local url `http://127.0.0.1:5000` this will show you index page of your project\n\n## Create flask app within your project (schoolsite)\n\nFor you to start an app within your project `schoolsite` shutdown the flask development server by pressing ( CTRL+C ) and then run the following command, by giving the name you want your app to be, in our case we will call our app `exam`\n\n```\npython thunder.py create_app -a exam\n```\n\nthis will create an app (a new package called `exam`) within your project `(schoolsite)`\n\n## Register an app\n\nOnce the app is created open a file `schoolsite/routes.py` and import your `exam` blueprint which is in (`exam/views.py`), default name given to an app blueprint, is the app name so our `exam` app blueprint name is `exam`, after importing it, append (register) the app blueprint in a list called `reg_blueprints` in that same file of `schoolsite/routes.py`\n\nimporting blueprint\n\n```py\nfrom exam.views import exam\n```\n\nregistering blueprint\n\n```py\nreg_blueprints = [\n blueprint.default,\n blueprint.errors,\n blueprint.auth,\n base,\n exam,\n]\n```\n\nonce you register the app, boot up the flask webserver again by\n\n```\npython thunder.py boot\n```\n\nvisit `http://127.0.0.1:5000` which is your project landing page\n\nvisit `http://127.0.0.1:5000/exam` this will take you to your app landing page (exam)\n\nvisit `http://127.0.0.1:5000/admin` this will take you to admin page. From there you are ready to go.\n\nSee more documentations <a href=\"https://sakyum.readthedocs.io\">here!</a>\n\n### Sakyum default page\n\n[](https://sakyum.readthedocs.io)\n\n## Useful links\n\n- Documentation: https://sakyum.readthedocs.io\n- Repository: https://github.com/usmanmusa1920/sakyum\n- Docker example: https://github.com/usmanmusa1920/sakyum/tree/master/example/sakyum-docker\n\nPull requests are welcome\n\n\nChange Log\n==========\n\n0.0.12 (23/june/2023)\n------------------\n\n- Twelveth Release\n\nTesting for OS compatibility also again! again!! again!!!\n\n- Eleventh Release\n\nTesting for OS compatibility again! again!! again!!!\n\n- Tenth Release\n\nTesting for OS compatibility again\n\n- Nineth Release\n\nFixing bugs\n\nFixing v0.0.8 bugs for OS compatibility, and also tested on windows OS\n\n- Eight Release\n\nOS compatibility\n\nMaking sakyum to be compatible with windows OS as well as other OS\n\n- Seventh Release\n\nThis release mostly is for adding more docs and examples.\n\n- Sixth Release\n\nAlembic is included as dependency (in the require module list).\n\n- Fifth Release\n\nIn fifith release, we handle how default user file system tricks is, things like when user change his profile picture.\n\n- Fourth Release\n\nIn this release we handle how we can customise the admin html page by inheriting (extends) it in our project templates/admin directory, and the admin page on how to bind models in the admin. Also I refactor other libraries that this package needs with their corresponding versions in the setup.py and requirements.txt files. In this release good documentations is well packed.\n\nDatabase migration is added using `alembic`\n\nSome error pages, default page were added but still you can customise it in your project sub folder (the package with the same name of your project in your project directory) in a file called `route.py`. Also an admin directory within your project templates folder is added too!\n\nPossibly other well things are added which include auth system for `users` and more.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "An extension of flask web framework that erase the complexity of structuring flask project blueprint, packages, and other annoying stuffs",
"version": "0.0.12",
"project_urls": {
"Documentation": "https://sakyum.readthedocs.io",
"Download": "https://pypi.org/project/sakyum",
"Homepage": "https://sakyum.readthedocs.io",
"Source": "https://github.com/usmanmusa1920/sakyum"
},
"split_keywords": [
"sakyum"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e21d13385b099733ff3f619232c78dcaaa5760ce5d82221e8dc424ae0f11b8d2",
"md5": "c907e7622137e4ecf06121d3da8bbfc5",
"sha256": "d39dd64794f9883255c9cd392c8797d66d94d7ebcc1787d02674a8844501d77a"
},
"downloads": -1,
"filename": "sakyum-0.0.12-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c907e7622137e4ecf06121d3da8bbfc5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 46801,
"upload_time": "2023-06-23T07:40:10",
"upload_time_iso_8601": "2023-06-23T07:40:10.921915Z",
"url": "https://files.pythonhosted.org/packages/e2/1d/13385b099733ff3f619232c78dcaaa5760ce5d82221e8dc424ae0f11b8d2/sakyum-0.0.12-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "02f99a58ce5bfe08cb02cb778001e1fbe0e86523015f1d009217dbb203f700db",
"md5": "c0dfa4de22562652807e22293ce30261",
"sha256": "2d5e8400e179cc7a7fa8e75f8585fc71b2ca44607971e23fa8d0d86f06d1020c"
},
"downloads": -1,
"filename": "sakyum-0.0.12.tar.gz",
"has_sig": false,
"md5_digest": "c0dfa4de22562652807e22293ce30261",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 35743,
"upload_time": "2023-06-23T07:40:22",
"upload_time_iso_8601": "2023-06-23T07:40:22.081688Z",
"url": "https://files.pythonhosted.org/packages/02/f9/9a58ce5bfe08cb02cb778001e1fbe0e86523015f1d009217dbb203f700db/sakyum-0.0.12.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-23 07:40:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "usmanmusa1920",
"github_project": "sakyum",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "sakyum"
}
