Metadata-Version: 2.3
Name: fymail
Version: 0.1.0
Summary: Find email for giving account in provider
Project-URL: Documentation, https://github.com/zhongjiajie/fymail#readme
Project-URL: Issues, https://github.com/zhongjiajie/fymail/issues
Project-URL: Source, https://github.com/zhongjiajie/fymail
Author-email: Jay Chung <zhongjiajie955@gmail.com>
License-Expression: MIT
License-File: LICENSE.txt
Keywords: email
Classifier: Development Status :: 1 - Planning
Classifier: Intended Audience :: Developers
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Software Development :: User Interfaces
Requires-Python: >=3.8
Requires-Dist: aiohttp>=3.7.4
Description-Content-Type: text/markdown

# FyMail

FyMail is a shortcut for *F*ind *Y*our e*Mail*. It is a simple tool to search for email addresses in a given
account with a given provider.

## Quick Start

```py
fymail = FyMail()
email = await fymail.get(iden="zhongjiajie", provider="github", auth=token)
```

Two lines to get the email address of a user, see whole example in [tutorial.py](./examples/tutorial.py)

## Bulk Search

see whole example in [bulk.py](./examples/bulk.py)
