| Name | kyaah JSON |
| Version |
0.1.17
JSON |
| download |
| home_page | https://kyaah.readthedocs.io |
| Summary | Kyaah abstract away cognitive over-head of sending SMTP mail, together with other mailing operations things like, mail with file, tokens etc. |
| upload_time | 2024-09-22 07:04:18 |
| maintainer | None |
| docs_url | None |
| author | Usman Musa |
| requires_python | >=3.7 |
| license | MIT |
| keywords |
kyaah
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Kyaah
Kyaah abstract away cognitive over-head of sending SMTP, POP3, and IMAP mail, together with other mailing operations things like, mail with file, tokens etc.
[](https://pypi.org/project/kyaah)
[](https://pypi.org/project/kyaah)
[](https://pypi.org/project/kyaah)
[](https://pypi.org/project/kyaah)
# Installation & Usage
First, you are recommended to create a virtual environment `python -m venv venv` and then activate it `source venv/bin/activate`, next install the library using:
```sh
pip install kyaah
```
Wait for the installation to finish, basically the library was uploaded using `sdist` (Source Distribution) and `bdist_wheel` (Built Distribution).
After that, simply import the library and set payload, which include `sender`, `receiver`, `subject`, `body`, and `password` and lastly call the `send` method and pass the `payload` as a keyword just like the sample below:
```python
import kyaah
payload = dict(
sender = "sender@gmail.com",
receiver = ["receiver@gmail.com"],
subject = "Hellow world!",
body = "Lorem ipsum dolor sit amet adipisicing elit, rerum voluptate ipsum volupt.",
password = "*********",
)
kyaah.send(credentials=payload)
```
> **Note**
> The password to use, is app password, take note that if you use your traditional mail password that you use to login, it won't give access to!
## Useful links
- Documentations: https://kyaah.readthedocs.io
- Repository: https://github.com/usmanmusa1920/kyaah
- PYPI Release: https://pypi.org/project/kyaah
Change Log
==========
## 0.1.17 (22/september/2024)
- 0.1.17 Release
Improve api design
- 0.1.16 Release
- Fixed api(s) for retrieving sender credentials from environment variable
- Include the `aiosmtpd` library as kyaah dependency for testing mail locally
- Revised local smtp server. Since `The asyncore module is deprecated and will be removed in Python 3.12. The recommended replacement is asyncio import asyncore` by implementing cli command for starting local SMTP server
- 0.1.15 Release
- Update CHANGELOG version of release (mistake of previous release v0.1.14 i.e `(*/august/2024)` to `(21/july/2024)`)
- 0.1.14 Release
- Changed naming convention of functions in `camelCase` to `snake_case`. Also making sure all other class are in `PascalCase`
- Implemented a single `send` function for all general sending mail operations (plain, file, image, & page), which replace previous ones:
- `local_mail`, `send_mail`, `send_images`, `send_files`, and `send_page`
- Implemented a single `fetch` function for fetching mail (POP & IMAP), which replace previous ones:
- `fetch_mail_POP`, and `fetch_mail_IMAP`
- Internal arrangement suggestion/guess of mail server
- Fixed mail with page, to ensure it send content of the page not the page itself
- 0.1.13 Release
- Add character style print (text & logging style)
- Add POP and IMAP
- Improve files naming slices
- Include email link (with expiration age)
- Changed the a required module of 'pstyle' to 'rgbpy'
- 0.1.12 Release
Docs
- 0.1.11 Release
Docs
- 0.1.10 Release
OS compatibility
- 0.1.9 Release
- 0.1.8 Release
This release mostly is for adding more documentations.
Raw data
{
"_id": null,
"home_page": "https://kyaah.readthedocs.io",
"name": "kyaah",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "kyaah",
"author": "Usman Musa",
"author_email": "usmanmusa1920@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/49/37/513217d1c58d57d762be29ff6e9b9d597aa08de64e0ea8364696a25e034f/kyaah-0.1.17.tar.gz",
"platform": "any",
"description": "# Kyaah\n\nKyaah abstract away cognitive over-head of sending SMTP, POP3, and IMAP mail, together with other mailing operations things like, mail with file, tokens etc.\n\n[](https://pypi.org/project/kyaah)\n[](https://pypi.org/project/kyaah)\n[](https://pypi.org/project/kyaah)\n[](https://pypi.org/project/kyaah)\n\n# Installation & Usage\n\nFirst, you are recommended to create a virtual environment `python -m venv venv` and then activate it `source venv/bin/activate`, next install the library using:\n\n```sh\n pip install kyaah\n```\n\nWait for the installation to finish, basically the library was uploaded using `sdist` (Source Distribution) and `bdist_wheel` (Built Distribution).\n\nAfter that, simply import the library and set payload, which include `sender`, `receiver`, `subject`, `body`, and `password` and lastly call the `send` method and pass the `payload` as a keyword just like the sample below:\n\n```python\n import kyaah\n \n payload = dict(\n sender = \"sender@gmail.com\",\n receiver = [\"receiver@gmail.com\"],\n subject = \"Hellow world!\",\n body = \"Lorem ipsum dolor sit amet adipisicing elit, rerum voluptate ipsum volupt.\",\n password = \"*********\",\n )\n\n kyaah.send(credentials=payload)\n```\n\n> **Note**\n> The password to use, is app password, take note that if you use your traditional mail password that you use to login, it won't give access to!\n\n## Useful links\n\n- Documentations: https://kyaah.readthedocs.io\n- Repository: https://github.com/usmanmusa1920/kyaah\n- PYPI Release: https://pypi.org/project/kyaah\n\n\nChange Log\n==========\n\n## 0.1.17 (22/september/2024)\n\n- 0.1.17 Release\n\n Improve api design\n\n- 0.1.16 Release\n\n - Fixed api(s) for retrieving sender credentials from environment variable\n - Include the `aiosmtpd` library as kyaah dependency for testing mail locally\n - Revised local smtp server. Since `The asyncore module is deprecated and will be removed in Python 3.12. The recommended replacement is asyncio import asyncore` by implementing cli command for starting local SMTP server\n\n- 0.1.15 Release\n\n - Update CHANGELOG version of release (mistake of previous release v0.1.14 i.e `(*/august/2024)` to `(21/july/2024)`)\n\n- 0.1.14 Release\n\n - Changed naming convention of functions in `camelCase` to `snake_case`. Also making sure all other class are in `PascalCase`\n - Implemented a single `send` function for all general sending mail operations (plain, file, image, & page), which replace previous ones:\n - `local_mail`, `send_mail`, `send_images`, `send_files`, and `send_page`\n - Implemented a single `fetch` function for fetching mail (POP & IMAP), which replace previous ones:\n - `fetch_mail_POP`, and `fetch_mail_IMAP`\n - Internal arrangement suggestion/guess of mail server\n - Fixed mail with page, to ensure it send content of the page not the page itself\n\n- 0.1.13 Release\n\n - Add character style print (text & logging style)\n - Add POP and IMAP\n - Improve files naming slices\n - Include email link (with expiration age)\n - Changed the a required module of 'pstyle' to 'rgbpy'\n\n- 0.1.12 Release\n\nDocs\n\n- 0.1.11 Release\n\nDocs\n\n- 0.1.10 Release\n\nOS compatibility\n\n- 0.1.9 Release\n\n- 0.1.8 Release\n\nThis release mostly is for adding more documentations.\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Kyaah abstract away cognitive over-head of sending SMTP mail, together with other mailing operations things like, mail with file, tokens etc.",
"version": "0.1.17",
"project_urls": {
"Documentation": "https://kyaah.readthedocs.io",
"Download": "https://pypi.org/project/kyaah",
"Homepage": "https://kyaah.readthedocs.io",
"Source": "https://github.com/usmanmusa1920/kyaah"
},
"split_keywords": [
"kyaah"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6cd57a2862ab45f7099be417f6c24e10d09e342a540506dfadb53fbc27dba88d",
"md5": "7b0260a93406c31a7cffb2c3df82826e",
"sha256": "470a5cbcd1229dd730381b5d43bd1e7ad6c0dd1d7657b08f72c69303b3486bd2"
},
"downloads": -1,
"filename": "kyaah-0.1.17-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "7b0260a93406c31a7cffb2c3df82826e",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.7",
"size": 18059,
"upload_time": "2024-09-22T07:04:15",
"upload_time_iso_8601": "2024-09-22T07:04:15.658098Z",
"url": "https://files.pythonhosted.org/packages/6c/d5/7a2862ab45f7099be417f6c24e10d09e342a540506dfadb53fbc27dba88d/kyaah-0.1.17-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4937513217d1c58d57d762be29ff6e9b9d597aa08de64e0ea8364696a25e034f",
"md5": "5c8cd439b335e731b1a8bfe53eadfebd",
"sha256": "f861cf18d425355a8edb76336455051ef48437df8e1ead7f9d6815d183473eaf"
},
"downloads": -1,
"filename": "kyaah-0.1.17.tar.gz",
"has_sig": false,
"md5_digest": "5c8cd439b335e731b1a8bfe53eadfebd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 18224,
"upload_time": "2024-09-22T07:04:18",
"upload_time_iso_8601": "2024-09-22T07:04:18.929263Z",
"url": "https://files.pythonhosted.org/packages/49/37/513217d1c58d57d762be29ff6e9b9d597aa08de64e0ea8364696a25e034f/kyaah-0.1.17.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-22 07:04:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "usmanmusa1920",
"github_project": "kyaah",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "kyaah"
}
