# MTLBS
   
> 
>
> Modular Template Login System
# Getting Started
## How to install?
To install the module using pip use the following command.
pip install mtlbs
Alternatively download the latest release of mtlbs on github
`<Latest Release>` : https://github.com/LofteaO/MTLBS/releases
## How to use?
**Import the module into your main application file**
app.py
1. #imports
2. import mtlbs as mtl
**Specifiy the template file location**
> .mt or .amt files are the only supported file format
1. #value of the template variable should be the path to the template file
2. template = "C:/Users/joshu/Desktop/Modular Login Sysmtem -Kivy/Betas/beta 1.0/test.mt"
***Refrence Code***
1. #imports
2. import mtlbs as mtl
3.
4. #value of the template variable should be the path to the template file
5. template = "C:/Users/joshu/Desktop/Modular Login Sysmtem -Kivy/Betas/beta 1.0/test.mt"
**Create variables for build, link & pull**
> Assign the link, build & pull variables for ease of use
1. link = mtlbs.link
2. build = mtlbs.build
3. pull = mtlbs.credentials.pull
***Refrence Code***
1. #imports
2. import mtlbs as mtl
3.
4. #value of the template variable should be the path to the template file
5. template = "C:/Users/joshu/Desktop/Modular Login Sysmtem -Kivy/Betas/beta 1.0/test.mt"
6.
7. link = mtl.link
8. build = mtl.build
9. pull = mtl.credentials.pull
*this step is **not** required**
**Specify the where the data will be stored/retrieved from locally or from a database**
***Locally:***
> The code required to locally store/retrieve data is the following.
link.local(path=None)
> The link.local represents the choice of storing/retrieving the data locally and if the path is set to **None**
> The data will be stored and retrieved by default from the AppData directory of the current User
> *Disclaimer** *IT IS **ADVISED** TO SET A PATH AS BY DEFAULT IT WILL ONLY WORK ON WINDOWS AND WILL BREAK ON NON-WINDOWS OPERATING SYSTEMS*
***Refrence Code***
1. #imports
2. import mtlbs as mtl
3.
4. #value of the template variable should be the path to the template file
5. template = "C:/Users/joshu/Desktop/Modular Login Sysmtem -Kivy/Betas/beta 1.0/test.mt"
6.
7. link = mtl.link
8. build = mtl.build
9. pull = mtl.credentials.pull
10.
11. link.local(path=None)
***With MDL-Api:***
> MDL api is a api made for mtlbs to link mtlbs to a database of your choice.
> MDL api is the only ***officially*** supported way to link mtlbs to a database without directly changing
> the code of mtlbs.
***Refrence Code***
1. #imports
2. import mtlbs as mtl
3.
4. #value of the template variable should be the path to the template file
5. template = "C:/Users/joshu/Desktop/Modular Login Sysmtem -Kivy/Betas/beta 1.0/test.mt"
6.
7. link = mtl.link
8. build = mtl.build
9. pull = mtl.credentials.pull
10.
11. link.local(path=None)
**Build the template**
> Code to build the template
> *Note** *the template var in the build call is the path to the template file*
build(template)
***Refrence Code***
> The build class **must** be called after the link class
1. #imports
2. import mtlbs as mtl
3.
4. #value of the template variable should be the path to the template file
5. template = "C:/Users/joshu/Desktop/Modular Login Sysmtem -Kivy/Betas/beta 1.0/test.mt"
6.
7. link = mtl.link
8. build = mtl.build
9. pull = mtl.credentials.pull
10.
10. link.local(path=None)
11. build(template)
**How to retrieve user data**
> Use the assigned pull class to retreive user data after the login process is complete
1. username = pull.username()
2. password = pull.password()
3. uuid = pull.uuid()
4.
5. #The print is only for debug purposed and is not needed
6. print(f"The username is: {username}\nThe password is {password}\nThe UUID is: {uuid}")
***Refrence Code***
1. #imports
2. import mtlbs as mtl
3.
4. #value of the template variable should be the path to the template file
5. template = "C:/Users/joshu/Desktop/Modular Login Sysmtem -Kivy/Betas/beta 1.0/test.mt"
6.
7. link = mtl.link
8. build = mtl.build
9. pull = mtl.credentials.pull
10.
10. link.local(path=None)
11. build(template)
12.
13. username = pull.username()
14. password = pull.password()
15. uuid = pull.uuid()
16.
17. print(f"The username is: {username}\nThe password is {password}\nThe UUID is: {uuid}")
Raw data
{
"_id": null,
"home_page": "",
"name": "mtlbs",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "python,login,GUI,simple,modular,user,fast,beginner",
"author": "Loftea",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/2c/37/f396f692b64c5de5f0e9d4fc5b609dbccc7a425756d8e1d8d4da8c87f210/mtlbs-0.0.6.tar.gz",
"platform": null,
"description": "\u00ef\u00bb\u00bf# MTLBS\r\n\r\n    \r\n\r\n> \r\n>\r\n> Modular Template Login System\r\n\r\n# Getting Started\r\n## How to install?\r\n\r\nTo install the module using pip use the following command.\r\n\r\n pip install mtlbs\r\n\r\nAlternatively download the latest release of mtlbs on github\r\n\r\n`<Latest Release>` : https://github.com/LofteaO/MTLBS/releases\r\n\r\n## How to use?\r\n\r\n**Import the module into your main application file**\r\n\r\n app.py\r\n \r\n 1. #imports\r\n 2. import mtlbs as mtl\r\n\r\n**Specifiy the template file location**\r\n\r\n> .mt or .amt files are the only supported file format\r\n\r\n 1. #value of the template variable should be the path to the template file\r\n 2. template = \"C:/Users/joshu/Desktop/Modular Login Sysmtem -Kivy/Betas/beta 1.0/test.mt\"\r\n\r\n***Refrence Code***\r\n\r\n 1. #imports\r\n 2. import mtlbs as mtl\r\n 3.\r\n 4. #value of the template variable should be the path to the template file\r\n 5. template = \"C:/Users/joshu/Desktop/Modular Login Sysmtem -Kivy/Betas/beta 1.0/test.mt\"\r\n\r\n**Create variables for build, link & pull**\r\n\r\n> Assign the link, build & pull variables for ease of use\r\n\r\n 1. link = mtlbs.link\r\n 2. build = mtlbs.build\r\n 3. pull = mtlbs.credentials.pull\r\n\r\n***Refrence Code***\r\n\r\n 1. #imports\r\n 2. import mtlbs as mtl\r\n 3. \r\n 4. #value of the template variable should be the path to the template file\r\n 5. template = \"C:/Users/joshu/Desktop/Modular Login Sysmtem -Kivy/Betas/beta 1.0/test.mt\"\r\n 6. \r\n 7. link = mtl.link\r\n 8. build = mtl.build\r\n 9. pull = mtl.credentials.pull\r\n*this step is **not** required** \r\n\r\n**Specify the where the data will be stored/retrieved from locally or from a database**\r\n\r\n***Locally:***\r\n\r\n> The code required to locally store/retrieve data is the following.\r\n\r\n link.local(path=None)\r\n\r\n> The link.local represents the choice of storing/retrieving the data locally and if the path is set to **None**\r\n> The data will be stored and retrieved by default from the AppData directory of the current User\r\n> *Disclaimer** *IT IS **ADVISED** TO SET A PATH AS BY DEFAULT IT WILL ONLY WORK ON WINDOWS AND WILL BREAK ON NON-WINDOWS OPERATING SYSTEMS*\r\n\r\n***Refrence Code***\r\n\r\n 1. #imports\r\n 2. import mtlbs as mtl\r\n 3. \r\n 4. #value of the template variable should be the path to the template file\r\n 5. template = \"C:/Users/joshu/Desktop/Modular Login Sysmtem -Kivy/Betas/beta 1.0/test.mt\"\r\n 6. \r\n 7. link = mtl.link\r\n 8. build = mtl.build\r\n 9. pull = mtl.credentials.pull\r\n 10.\r\n 11. link.local(path=None) \r\n\r\n***With MDL-Api:***\r\n\r\n> MDL api is a api made for mtlbs to link mtlbs to a database of your choice.\r\n> MDL api is the only ***officially*** supported way to link mtlbs to a database without directly changing\r\n> the code of mtlbs.\r\n\r\n***Refrence Code***\r\n \r\n 1. #imports\r\n 2. import mtlbs as mtl\r\n 3. \r\n 4. #value of the template variable should be the path to the template file\r\n 5. template = \"C:/Users/joshu/Desktop/Modular Login Sysmtem -Kivy/Betas/beta 1.0/test.mt\"\r\n 6. \r\n 7. link = mtl.link\r\n 8. build = mtl.build\r\n 9. pull = mtl.credentials.pull \r\n 10. \r\n 11. link.local(path=None) \r\n\r\n**Build the template** \r\n\r\n> Code to build the template\r\n> *Note** *the template var in the build call is the path to the template file*\r\n\r\n build(template)\r\n\r\n***Refrence Code***\r\n\r\n> The build class **must** be called after the link class\r\n\r\n 1. #imports\r\n 2. import mtlbs as mtl\r\n 3. \r\n 4. #value of the template variable should be the path to the template file\r\n 5. template = \"C:/Users/joshu/Desktop/Modular Login Sysmtem -Kivy/Betas/beta 1.0/test.mt\"\r\n 6. \r\n 7. link = mtl.link\r\n 8. build = mtl.build\r\n 9. pull = mtl.credentials.pull \r\n 10.\r\n 10. link.local(path=None)\r\n 11. build(template) \r\n\r\n**How to retrieve user data**\r\n\r\n> Use the assigned pull class to retreive user data after the login process is complete\r\n\r\n 1. username = pull.username()\r\n 2. password = pull.password()\r\n 3. uuid = pull.uuid()\r\n 4.\r\n\t5. #The print is only for debug purposed and is not needed\r\n 6. print(f\"The username is: {username}\\nThe password is {password}\\nThe UUID is: {uuid}\")\r\n\r\n***Refrence Code***\r\n\r\n 1. #imports\r\n 2. import mtlbs as mtl\r\n 3. \r\n 4. #value of the template variable should be the path to the template file\r\n 5. template = \"C:/Users/joshu/Desktop/Modular Login Sysmtem -Kivy/Betas/beta 1.0/test.mt\"\r\n 6. \r\n 7. link = mtl.link\r\n 8. build = mtl.build\r\n 9. pull = mtl.credentials.pull \r\n 10.\r\n 10. link.local(path=None)\r\n 11. build(template) \r\n 12. \r\n 13. username = pull.username()\r\n 14. password = pull.password()\r\n 15. uuid = pull.uuid()\r\n 16. \r\n 17. print(f\"The username is: {username}\\nThe password is {password}\\nThe UUID is: {uuid}\")\r\n\r\n",
"bugtrack_url": null,
"license": "",
"summary": "A modular login system",
"version": "0.0.6",
"project_urls": null,
"split_keywords": [
"python",
"login",
"gui",
"simple",
"modular",
"user",
"fast",
"beginner"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2b36054cab8e3e0ede57b9bec1ee975893420f8cbfe2eac4f50458266fea14db",
"md5": "03650410c316a4d0d4db4f7bdaf40327",
"sha256": "84441f46eb3cc7a81a7d3ea81a1bfd50da2249ef092e456eb82c454f4100fb9b"
},
"downloads": -1,
"filename": "mtlbs-0.0.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "03650410c316a4d0d4db4f7bdaf40327",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6189,
"upload_time": "2024-03-13T14:26:10",
"upload_time_iso_8601": "2024-03-13T14:26:10.113291Z",
"url": "https://files.pythonhosted.org/packages/2b/36/054cab8e3e0ede57b9bec1ee975893420f8cbfe2eac4f50458266fea14db/mtlbs-0.0.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2c37f396f692b64c5de5f0e9d4fc5b609dbccc7a425756d8e1d8d4da8c87f210",
"md5": "a46da0389b53af2573dcaa0d1b42df2d",
"sha256": "20b88ef1560fb1334a4510b27425f865f9d633d85f6fc5ec37a08fb300d90977"
},
"downloads": -1,
"filename": "mtlbs-0.0.6.tar.gz",
"has_sig": false,
"md5_digest": "a46da0389b53af2573dcaa0d1b42df2d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7054,
"upload_time": "2024-03-13T14:26:13",
"upload_time_iso_8601": "2024-03-13T14:26:13.387346Z",
"url": "https://files.pythonhosted.org/packages/2c/37/f396f692b64c5de5f0e9d4fc5b609dbccc7a425756d8e1d8d4da8c87f210/mtlbs-0.0.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-13 14:26:13",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "mtlbs"
}
JSON