# Install
**Pypi**
```
pip install encurtanet
```
# Simple use example
```py
from encurtanet import EncurtaNet, AdsTypes
encurtanet = EncurtaNet("YOUR API TOKEN HERE")
url_info = encurtanet.shorten(
url = "https://marcuth.github.io/", # URL you want to shorten
alias = "url-alias", # URL alias
is_text_format = False, # Whether the result from the server is going to be text
ads_type = AdsTypes.InterstitialAds # Ads type, you can define two types, there is no way to define banner and also you don't need to define if you want url with ads
)
url_info.raw_data # Result of all
url_info.shortened_url # Resulting URL
url_info.status # Resulting status ("success" | "error")
url_info.message # Resulting message (if the api sent a message)
```
Raw data
{
"_id": null,
"home_page": "",
"name": "encurtanet",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "encurtanet wrapper api",
"author": "Marcuth",
"author_email": "marcuth2006@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/89/de/34643ebdeb0a951c15931b9b4b87a8e23579b883886c8dfa6b5517468ddf/encurtanet-0.1.0.tar.gz",
"platform": null,
"description": "# Install\r\n\r\n**Pypi**\r\n```\r\npip install encurtanet\r\n```\r\n\r\n# Simple use example\r\n```py\r\nfrom encurtanet import EncurtaNet, AdsTypes\r\n\r\nencurtanet = EncurtaNet(\"YOUR API TOKEN HERE\")\r\n\r\nurl_info = encurtanet.shorten(\r\n url = \"https://marcuth.github.io/\", # URL you want to shorten\r\n alias = \"url-alias\", # URL alias\r\n is_text_format = False, # Whether the result from the server is going to be text\r\n ads_type = AdsTypes.InterstitialAds # Ads type, you can define two types, there is no way to define banner and also you don't need to define if you want url with ads\r\n)\r\n\r\nurl_info.raw_data # Result of all \r\nurl_info.shortened_url # Resulting URL\r\nurl_info.status # Resulting status (\"success\" | \"error\")\r\nurl_info.message # Resulting message (if the api sent a message)\r\n```\r\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "",
"version": "0.1.0",
"project_urls": null,
"split_keywords": [
"encurtanet",
"wrapper",
"api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "89de34643ebdeb0a951c15931b9b4b87a8e23579b883886c8dfa6b5517468ddf",
"md5": "1792be24485d2641944eb189f7462818",
"sha256": "50e1a62c682aca89b4242af2bccd40ff21c0cf2ff4fa802e84bd32da03333744"
},
"downloads": -1,
"filename": "encurtanet-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "1792be24485d2641944eb189f7462818",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3136,
"upload_time": "2024-02-16T15:50:27",
"upload_time_iso_8601": "2024-02-16T15:50:27.319854Z",
"url": "https://files.pythonhosted.org/packages/89/de/34643ebdeb0a951c15931b9b4b87a8e23579b883886c8dfa6b5517468ddf/encurtanet-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-16 15:50:27",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "encurtanet"
}