| Name | s3ssion JSON |
| Version |
1.0.2
JSON |
| download |
| home_page | |
| Summary | Login Session Manager |
| upload_time | 2024-03-19 02:56:01 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.9 |
| license | MIT License Copyright (c) 2024 Soumyo Deep Gupta 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 |
d33pster
login
session
session-manager
login-manager
login-screen
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# <p align='center'>s3ssion</p>
<br>
<br><br><br>
v1.0.2
<p align='center'>
<a href='#Installation'>Installation</a>
|
<a href='#Usage'>Usage</a>
</p><br>
## About
Session helps creating login sessions.
## Installation
```console
## run
$ pip install s3ssion
```
## Usage
###### initialization
```console
>>> from s3ssion import s3ssion
>>> sess = s3ssion('password')
```
for help with session class initialization
```console
>>> from s3ssion import s3ssion
>>> help(s3ssion)
```
###### class functions
```console
>>> from s3ssion import s3ssion
# _login()_ function
>>> help(s3ssion._login_)
Help on function _login_ in module src.s3ssion:
_login_(self, username: str, password: str)
login user
Args:
username (str): username to login
password (str): password for username
Returns:
error (str | None): returns error text, if all good then error=None
```
```console
# _register_() function
>>> help(s3ssion._register_)
Help on function _register_ in module src.s3ssion:
_register_(self, **kwargs)
register function.
ARGS:
NOTE: whatever field you entered during the class initialization, add them. default -> ['name', 'username', 'password'].
Returns:
error (str | None): returns error text if any, else None
```
```console
# _logout_() function
>>> help(s3ssion._logout_)
Help on function _logout_ in module src.s3ssion:
_logout_(self)
logout currently logged in user
Returns:
error (str | None): returns error text or None
```
```console
# _change_password_() function
>>> help(s3ssion._change_password_)
Help on function _change_password_ in module src.s3ssion:
_change_password_(self, username: str, old_password: str, new_password: str)
change user password.
Args:
username (str): username of the user
old_password (str): old password
new_password (str): new password
Returns:
error (str | None): returns error text or None
```
```console
# _login_who_() function
>>> help(s3ssion._login_who_)
Help on function _login_who_ in module src.s3ssion:
_login_who_(self)
returns currently logged in user
Returns:
username (str): currently logged in user.
```
```console
# _login_status_() function
>>> help(s3ssion._login_function_)
Help on function _login_status_ in module src.s3ssion:
_login_status_(self)
get login status
Returns:
status (bool): returns if anyone is currently logged in.
```
```console
# _user_count_() function
>>> help(s3ssion._user_count_)
Help on function _user_count_ in module src.s3ssion:
_user_count_(self)
get registered user count
Returns:
usercount (int): Number of users currently registered.
```
```console
# _force_login_() function
>>> help(s3ssion._force_login_)
Help on function _force_login_ in module src.s3ssion:
_force_login_(self, username: str)
forcefully login an user.
Args:
username (str): username to forcefully login.
```
Raw data
{
"_id": null,
"home_page": "",
"name": "s3ssion",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "Soumyo Deep Gupta <deep.main.ac@gmail.com>",
"keywords": "d33pster,login,session,session-manager,login-manager,login-screen",
"author": "",
"author_email": "Soumyo Deep Gupta <deep.main.ac@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/35/8e/0fb2dc3168b395f79ee52266951ac8971c4c4cf9350b69fb8c1501403696/s3ssion-1.0.2.tar.gz",
"platform": null,
"description": "# <p align='center'>s3ssion</p>\n<br>\n\n\n\n\n\n\n<br><br><br>\nv1.0.2\n\n<p align='center'>\n <a href='#Installation'>Installation</a>\n | \n <a href='#Usage'>Usage</a>\n</p><br>\n\n## About\nSession helps creating login sessions.\n\n## Installation\n```console\n## run\n$ pip install s3ssion\n```\n\n## Usage\n\n###### initialization\n```console\n>>> from s3ssion import s3ssion\n>>> sess = s3ssion('password')\n```\nfor help with session class initialization\n```console\n>>> from s3ssion import s3ssion\n>>> help(s3ssion)\n```\n\n###### class functions\n```console\n>>> from s3ssion import s3ssion\n\n# _login()_ function\n>>> help(s3ssion._login_)\n\nHelp on function _login_ in module src.s3ssion:\n\n_login_(self, username: str, password: str)\n login user\n\n Args:\n username (str): username to login\n password (str): password for username\n\n Returns:\n error (str | None): returns error text, if all good then error=None\n```\n\n```console\n# _register_() function\n>>> help(s3ssion._register_)\n\nHelp on function _register_ in module src.s3ssion:\n\n_register_(self, **kwargs)\n register function.\n\n ARGS:\n NOTE: whatever field you entered during the class initialization, add them. default -> ['name', 'username', 'password'].\n Returns:\n error (str | None): returns error text if any, else None\n```\n\n```console\n# _logout_() function\n>>> help(s3ssion._logout_)\n\nHelp on function _logout_ in module src.s3ssion:\n\n_logout_(self)\n logout currently logged in user\n\n Returns:\n error (str | None): returns error text or None\n```\n\n```console\n# _change_password_() function\n>>> help(s3ssion._change_password_)\n\nHelp on function _change_password_ in module src.s3ssion:\n\n_change_password_(self, username: str, old_password: str, new_password: str)\n change user password.\n\n Args:\n username (str): username of the user\n old_password (str): old password\n new_password (str): new password\n\n Returns:\n error (str | None): returns error text or None\n```\n\n```console\n# _login_who_() function\n>>> help(s3ssion._login_who_)\n\nHelp on function _login_who_ in module src.s3ssion:\n\n_login_who_(self)\n returns currently logged in user\n\n Returns:\n username (str): currently logged in user.\n```\n\n```console\n# _login_status_() function\n>>> help(s3ssion._login_function_)\n\nHelp on function _login_status_ in module src.s3ssion:\n\n_login_status_(self)\n get login status\n\n Returns:\n status (bool): returns if anyone is currently logged in.\n```\n\n```console\n# _user_count_() function\n>>> help(s3ssion._user_count_)\n\nHelp on function _user_count_ in module src.s3ssion:\n\n_user_count_(self)\n get registered user count\n\n Returns:\n usercount (int): Number of users currently registered.\n```\n\n```console\n# _force_login_() function\n>>> help(s3ssion._force_login_)\n\nHelp on function _force_login_ in module src.s3ssion:\n\n_force_login_(self, username: str)\n forcefully login an user.\n\n Args:\n username (str): username to forcefully login.\n```\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Soumyo Deep Gupta 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": "Login Session Manager",
"version": "1.0.2",
"project_urls": {
"Homepage": "https://github.com/d33pster/s3ssion",
"Issues": "https://github.com/d33pster/s3ssion/issues"
},
"split_keywords": [
"d33pster",
"login",
"session",
"session-manager",
"login-manager",
"login-screen"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e56a926ef07513153b9132f3938cc0d9813f3041f6082bbeba636c20437a590c",
"md5": "bd5d5d76d367698c9220fb27da4b757b",
"sha256": "056ed024d43f1f6d37c6a458e9fdb946ba151df39e51beeb0e3cb7f0152a71fe"
},
"downloads": -1,
"filename": "s3ssion-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bd5d5d76d367698c9220fb27da4b757b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 5331,
"upload_time": "2024-03-19T02:55:42",
"upload_time_iso_8601": "2024-03-19T02:55:42.849731Z",
"url": "https://files.pythonhosted.org/packages/e5/6a/926ef07513153b9132f3938cc0d9813f3041f6082bbeba636c20437a590c/s3ssion-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "358e0fb2dc3168b395f79ee52266951ac8971c4c4cf9350b69fb8c1501403696",
"md5": "161d345bc71cd43a1ba7dfcec089e2a7",
"sha256": "cf256c79cd8ef48778ff503891cf43e877a66395df37fffa43d82a3e8fa79b92"
},
"downloads": -1,
"filename": "s3ssion-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "161d345bc71cd43a1ba7dfcec089e2a7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 4426,
"upload_time": "2024-03-19T02:56:01",
"upload_time_iso_8601": "2024-03-19T02:56:01.199031Z",
"url": "https://files.pythonhosted.org/packages/35/8e/0fb2dc3168b395f79ee52266951ac8971c4c4cf9350b69fb8c1501403696/s3ssion-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-19 02:56:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "d33pster",
"github_project": "s3ssion",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "s3ssion"
}
