<!-- PROJECT LOGO -->
<br />
<div align="center">
<a href="https://github.com/kevinnadar22/shortzy">
<img src="https://bit.ly/3ow4n7S" alt="Logo" width="80" height="80">
</a>
<h3 align="center">Shortzy</h3>
<p align="center">
A Unofficial Wrapper for Adlinkfly Site and Alternative Sites
<br />
·
<a href="https://www.telegram.dog/ask_admin001">Report Bug / Request Feature</a>
·
<a href="#usage">Usage</a>
·
<a href="#reference">Reference</a>
</p>
</div>
---
# Shortzy
An Unofficial Python version of Adlinkfly and Alternative Website API wrapper. Used to Short your long link and let you earn from it.
## Installation
Install shortzy with pip
```bash
pip install shortzy
```
To Upgrade
```bash
pip install --upgrade shortzy
```
## Usage
```python
from shortzy import Shortzy
import asyncio
shortzy = Shortzy('<YOUR API KEY>')
async def main():
link = await shortzy.convert('https://example.com/')
print(link)
asyncio.run(main())
```
```python
Output: https://droplink.co/mVkra
```
## Available Websites
<!-- TABLE OF CONTENTS -->
<details>
<summary>Available list of Websites</summary>
<ol>
<li><a href="https://droplink.co" target="_blank">droplink.co</a></li>
<li><a href="https://gplinks.in" target="_blank">gplinks.in</a></li>
<li><a href="https://tnlink.in" target="_blank">tnlink.in</a></li>
<li><a href="https://za.gl" target="_blank">za.gl</a></li>
<li><a href="https://du-link.in" target="_blank">du-link.in</a></li>
<li><a href="https://viplink.in" target="_blank">viplink.in</a></li>
<li><a href="https://shorturllink.in" target="_blank">shorturllink.in</a></li>
<li><a href="https://shareus.in" target="_blank">shareus.in</a></li>
<li><a href="https://telegram.me/ask_admin001">Request For Your Website !</a></li>
</ol>
</details>
## Features
- Single URL Convert
- Batch Convert from List
- Convert from Text
## Contributing
Contributions are always welcome!
## Reference
### Init
```python
from shortzy import Shortzy
import asyncio
shortzy = Shortzy(api_key="Your API Key", base_site="droplink.co")
# Base site defaults to "droplink.co". You can add your own site here which is alternative to this default site
# Please Refer https://github.com/kevinnadar22/shortzy#available-websites for more information
```
### Convert a single URL
```python
convert(link, alias, silently_fail, quick_link) -> str
```
| Parameter | Type | Description |
| :-------- | :------- | :------------------------- |
| `link` | `string` | **Required**. Long URL Link |
| `alias` | `string` | Custom alias for the link |
| `silently_fail` | `bool` | Raise an exception or not if error ocuurs |
| `quick_link` | `bool` | Returns the quick link |
Example:
```python
async def main():
link = await shortzy.convert('https://www.youtube.com/watch?v=d8RLHL3Lizw')
print(link)
asyncio.run(main())
## Output: https://droplink.co/Ly4fCxZ
## Quick Link: https://droplink.co/st?api=<YOUR API KEY>&url=https://www.youtube.com/watch?v=d8RLHL3Lizw
```
### Bulk Convert
```python
bulk_convert(urls:list, silently_fail, quick_link:bool=False) -> list
```
| Parameter | Type | Description |
| :-------- | :------- | :-------------------------------- |
| `urls` | `list` | **Required**. List of URLs to convert |
Example:
```python
async def main():
links = ['https://github.com/', 'https://twitter.com/', 'https://google.com/']
link = await shortzy.bulk_convert(links)
print(link)
asyncio.run(main())
## Output: ['https://droplink.co/ihu1e', 'https://droplink.co/AkY2Nt', 'https://droplink.co/mK1eVTV']
```
### Convert from Text
```python
convert_from_text(text:str, silently_fail:bool=True, quick_link:bool=False) -> str
```
| Parameter | Type | Description |
| :-------- | :------- | :-------------------------------- |
| `text` | `str` | **Required**. Text containing Long URLS to short|
Example:
```python
async def main():
text = """
Unstoppable:-https://www.youtube.com/watch?v=330xlOv8p9M
Night Changes:-https://www.youtube.com/watch?v=syFZfO_wfMQ
"""
link = await shortzy.convert_from_text(text)
print(link)
asyncio.run(main())
# Output:
# "Unstoppable:-https://droplink.co/T6jbHlU
# Night Changes:-https://droplink.co/ajIRE"
```
### Get quick link
```python
get_quick_link(link:str)
```
| Parameter | Type | Description |
| :-------- | :------- | :-------------------------------- |
| `link` | `str` | **Required**. Long Link|
Example:
```python
async def main():
link = "https://www.youtube.com/watch?v=syFZfO_wfMQ"
quick_link = await shortzy.get_quick_link(link)
print(quick_link)
asyncio.run(main())
## Quick Link: https://droplink.co/st?api=<YOUR API KEY>&url=https://www.youtube.com/watch?v=syFZfO_wfMQ
```
## Support
For support, email jesikamaraj@gmail.com or PM [Dev](https://t.me/ask_admin001)
## Roadmap
- Add more integrations
## Disclaimer
[](https://www.gnu.org/licenses/agpl-3.0.en.html#header)
Licensed under [GNU AGPL v3.0.](https://github.com/kevinnadar22/shortzy/blob/main/LICENSE)
Selling The Codes To Other People For Money Is *Strictly Prohibited*.
## Credits
- [Thanks To Me](https://github.com/Kevinnadar22)
Raw data
{
"_id": null,
"home_page": "https://github.com/kevinnadar22/shortzy",
"name": "shortzy",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "python,droplink,gplink,url-shortener,earn money,shareus,adlinkfly",
"author": "Kevin Nadar",
"author_email": "jesikamaraj@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/1f/38/d3c4c2898dee0cfc21611ea264896259b9526305a47b7b6d62a428c2867d/shortzy-0.0.8.tar.gz",
"platform": null,
"description": "\n\n\n<!-- PROJECT LOGO -->\n<br />\n<div align=\"center\">\n <a href=\"https://github.com/kevinnadar22/shortzy\">\n <img src=\"https://bit.ly/3ow4n7S\" alt=\"Logo\" width=\"80\" height=\"80\">\n </a>\n\n <h3 align=\"center\">Shortzy</h3>\n\n <p align=\"center\">\n A Unofficial Wrapper for Adlinkfly Site and Alternative Sites\n <br />\n \u00b7\n <a href=\"https://www.telegram.dog/ask_admin001\">Report Bug / Request Feature</a>\n \u00b7\n <a href=\"#usage\">Usage</a>\n \u00b7\n <a href=\"#reference\">Reference</a>\n </p>\n</div>\n\n\n---\n\n# Shortzy\nAn Unofficial Python version of Adlinkfly and Alternative Website API wrapper. Used to Short your long link and let you earn from it.\n\n\n## Installation\n\nInstall shortzy with pip\n\n```bash\npip install shortzy\n```\n \nTo Upgrade\n\n```bash\npip install --upgrade shortzy\n```\n \n \n## Usage\n\n```python\nfrom shortzy import Shortzy\nimport asyncio\n\nshortzy = Shortzy('<YOUR API KEY>')\n\nasync def main():\n link = await shortzy.convert('https://example.com/')\n print(link)\n\nasyncio.run(main())\n```\n\n```python\nOutput: https://droplink.co/mVkra\n```\n\n## Available Websites\n\n<!-- TABLE OF CONTENTS -->\n<details>\n <summary>Available list of Websites</summary>\n <ol>\n <li><a href=\"https://droplink.co\" target=\"_blank\">droplink.co</a></li>\n <li><a href=\"https://gplinks.in\" target=\"_blank\">gplinks.in</a></li>\n <li><a href=\"https://tnlink.in\" target=\"_blank\">tnlink.in</a></li>\n <li><a href=\"https://za.gl\" target=\"_blank\">za.gl</a></li>\n <li><a href=\"https://du-link.in\" target=\"_blank\">du-link.in</a></li>\n <li><a href=\"https://viplink.in\" target=\"_blank\">viplink.in</a></li>\n <li><a href=\"https://shorturllink.in\" target=\"_blank\">shorturllink.in</a></li>\n <li><a href=\"https://shareus.in\" target=\"_blank\">shareus.in</a></li>\n <li><a href=\"https://telegram.me/ask_admin001\">Request For Your Website !</a></li>\n </ol>\n</details>\n\n## Features\n\n- Single URL Convert\n- Batch Convert from List\n- Convert from Text\n\n## Contributing\n\nContributions are always welcome!\n\n## Reference\n\n### Init\n```python\nfrom shortzy import Shortzy\nimport asyncio\n\nshortzy = Shortzy(api_key=\"Your API Key\", base_site=\"droplink.co\") \n\n# Base site defaults to \"droplink.co\". You can add your own site here which is alternative to this default site\n# Please Refer https://github.com/kevinnadar22/shortzy#available-websites for more information\n```\n\n### Convert a single URL\n\n```python\nconvert(link, alias, silently_fail, quick_link) -> str\n```\n\n| Parameter | Type | Description |\n| :-------- | :------- | :------------------------- |\n| `link` | `string` | **Required**. Long URL Link |\n| `alias` | `string` | Custom alias for the link |\n| `silently_fail` | `bool` | Raise an exception or not if error ocuurs |\n| `quick_link` | `bool` | Returns the quick link |\n\n\nExample:\n\n```python\nasync def main():\n link = await shortzy.convert('https://www.youtube.com/watch?v=d8RLHL3Lizw')\n print(link)\n\nasyncio.run(main())\n\n## Output: https://droplink.co/Ly4fCxZ\n## Quick Link: https://droplink.co/st?api=<YOUR API KEY>&url=https://www.youtube.com/watch?v=d8RLHL3Lizw\n```\n\n### Bulk Convert\n\n```python\nbulk_convert(urls:list, silently_fail, quick_link:bool=False) -> list\n```\n\n| Parameter | Type | Description |\n| :-------- | :------- | :-------------------------------- |\n| `urls` | `list` | **Required**. List of URLs to convert |\n\nExample:\n\n```python\nasync def main():\n links = ['https://github.com/', 'https://twitter.com/', 'https://google.com/']\n link = await shortzy.bulk_convert(links)\n print(link)\n\nasyncio.run(main())\n\n## Output: ['https://droplink.co/ihu1e', 'https://droplink.co/AkY2Nt', 'https://droplink.co/mK1eVTV']\n```\n\n### Convert from Text\n\n```python\nconvert_from_text(text:str, silently_fail:bool=True, quick_link:bool=False) -> str\n```\n\n| Parameter | Type | Description |\n| :-------- | :------- | :-------------------------------- |\n| `text` | `str` | **Required**. Text containing Long URLS to short|\n\nExample:\n\n```python\nasync def main():\n text = \"\"\"\nUnstoppable:-https://www.youtube.com/watch?v=330xlOv8p9M\nNight Changes:-https://www.youtube.com/watch?v=syFZfO_wfMQ\n\"\"\"\n link = await shortzy.convert_from_text(text)\n print(link)\n\nasyncio.run(main())\n\n# Output:\n# \"Unstoppable:-https://droplink.co/T6jbHlU\n# Night Changes:-https://droplink.co/ajIRE\"\n```\n\n### Get quick link\n\n```python\nget_quick_link(link:str)\n```\n\n| Parameter | Type | Description |\n| :-------- | :------- | :-------------------------------- |\n| `link` | `str` | **Required**. Long Link|\n\nExample:\n\n```python\nasync def main():\n link = \"https://www.youtube.com/watch?v=syFZfO_wfMQ\"\n quick_link = await shortzy.get_quick_link(link)\n print(quick_link)\n\nasyncio.run(main())\n\n## Quick Link: https://droplink.co/st?api=<YOUR API KEY>&url=https://www.youtube.com/watch?v=syFZfO_wfMQ\n```\n\n## Support\n\nFor support, email jesikamaraj@gmail.com or PM [Dev](https://t.me/ask_admin001)\n\n## Roadmap\n\n- Add more integrations\n\n## Disclaimer\n\n[](https://www.gnu.org/licenses/agpl-3.0.en.html#header) \nLicensed under [GNU AGPL v3.0.](https://github.com/kevinnadar22/shortzy/blob/main/LICENSE)\nSelling The Codes To Other People For Money Is *Strictly Prohibited*.\n\n\n## Credits\n - [Thanks To Me](https://github.com/Kevinnadar22)\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "An Unofficial Asynchronous Python version of Adlinkfly and Alternative Website API wrapper",
"version": "0.0.8",
"project_urls": {
"Homepage": "https://github.com/kevinnadar22/shortzy"
},
"split_keywords": [
"python",
"droplink",
"gplink",
"url-shortener",
"earn money",
"shareus",
"adlinkfly"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9672701fdcfb55d876862dd7b53fefb81caf7fab9f2dc5bc9fcd064d6b6e8b10",
"md5": "2a1622a5f4322e888159bb562ab5afba",
"sha256": "7f233cd02a51b3703a9896d9082092417081f4ff286dfe2cfa9fd052744fe40f"
},
"downloads": -1,
"filename": "shortzy-0.0.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2a1622a5f4322e888159bb562ab5afba",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 22134,
"upload_time": "2023-07-06T16:37:25",
"upload_time_iso_8601": "2023-07-06T16:37:25.375709Z",
"url": "https://files.pythonhosted.org/packages/96/72/701fdcfb55d876862dd7b53fefb81caf7fab9f2dc5bc9fcd064d6b6e8b10/shortzy-0.0.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1f38d3c4c2898dee0cfc21611ea264896259b9526305a47b7b6d62a428c2867d",
"md5": "7dde03f863d28d122daf19f1f6c9eaae",
"sha256": "9622cc0a2a2c42e9db1b8e2af36da82d133a047887453a64deccf1da79c89852"
},
"downloads": -1,
"filename": "shortzy-0.0.8.tar.gz",
"has_sig": false,
"md5_digest": "7dde03f863d28d122daf19f1f6c9eaae",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 20196,
"upload_time": "2023-07-06T16:37:27",
"upload_time_iso_8601": "2023-07-06T16:37:27.881841Z",
"url": "https://files.pythonhosted.org/packages/1f/38/d3c4c2898dee0cfc21611ea264896259b9526305a47b7b6d62a428c2867d/shortzy-0.0.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-06 16:37:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kevinnadar22",
"github_project": "shortzy",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "shortzy"
}
JSON
