CuttApi


NameCuttApi JSON
Version 1.0.1 PyPI version JSON
download
home_pagehttps://github.com/devrajdevs/CuttApi
SummaryOne of the best ways of shortening URLs using Cuttly URL shortener just by entering your API key and seeing the rest that is done automatically by the Module
upload_time2024-09-17 13:08:14
maintainerNone
docs_urlNone
authorDevraj Therani
requires_pythonNone
licenseMIT
keywords api simple url shortener
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # CuttApi

One of the best URL shortener modules for Python of all time!

CuttApi is one of the best ways of shortening URLs using Cuttly URL shortener just by entering your API key and seeing the rest that is done automatically by the Module

## Installation

Installing requirements to establish the Module:

```
requests
urllib3
pyperclip
```

**Use pip to Install the above Modules**

## Usage

The only thing users need to do is:

```python
from CuttApi import Cuttshort
import stdiomask
api_key = stdiomask.getpass("Enter your Cuttly api key: ")
short = Cuttshort(api_key)
```

* If you enter the correct API key, then you proceed.
* But if you enter a wrong one, you proceed only after entering the correct one.
* As you proceed, the same thing happens with Links and Alias (if you wanna give), but that's good since the process doesn't start over from the start of entering the API key.

## yurl

Cuttshort class is supported by one more class which is a URL corrector as well as checker!

```python
from CuttApi import yurl
a = yurl("google.com").link
print(a)
```

This returns `https://www.google.com/` And that happens whether you put:
* google.com
* http://google.com
* https://google.com
* google.com/
* http://google.com/
* https://google.com/
* www.google.com
* http://www.google.com
* https://www.google.com
* www.google.com/
* http://www.google.com/
* https://www.google.com/

## Privacy

CuttApi developer respects your privacy! The data you enter does not go over the net except to CuttLy for creations and updates. The data you enter is safely stored on your device, so that you can work on links and find them easily!

Please keep the following points in mind:
* Don't delete the file to make sure you have the best experience!
* The file is stored with the name as your API key, so any manual updates by the user to this file can cause the user not being able to use the latest feature!
* Multiple API keys can be used on the same device!

## Feedback

Feedbacks are vital for any software! You say, we make, you try @ https://cutt.ly/CuttApifeedback

## License

MIT

Copyright (c) 2024 Devraj Therani

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.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/devrajdevs/CuttApi",
    "name": "CuttApi",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "API, SIMPLE, URL, SHORTENER",
    "author": "Devraj Therani",
    "author_email": "ttctlc96e@mozmail.com",
    "download_url": "https://files.pythonhosted.org/packages/3c/c9/150a4fceea27d73d227c61fd0faab2626b070a1a51b3d6eda9d9cc007fbd/cuttapi-1.0.1.tar.gz",
    "platform": null,
    "description": "# CuttApi\r\n\r\nOne of the best URL shortener modules for Python of all time!\r\n\r\nCuttApi is one of the best ways of shortening URLs using Cuttly URL shortener just by entering your API key and seeing the rest that is done automatically by the Module\r\n\r\n## Installation\r\n\r\nInstalling requirements to establish the Module:\r\n\r\n```\r\nrequests\r\nurllib3\r\npyperclip\r\n```\r\n\r\n**Use pip to Install the above Modules**\r\n\r\n## Usage\r\n\r\nThe only thing users need to do is:\r\n\r\n```python\r\nfrom CuttApi import Cuttshort\r\nimport stdiomask\r\napi_key = stdiomask.getpass(\"Enter your Cuttly api key: \")\r\nshort = Cuttshort(api_key)\r\n```\r\n\r\n* If you enter the correct API key, then you proceed.\r\n* But if you enter a wrong one, you proceed only after entering the correct one.\r\n* As you proceed, the same thing happens with Links and Alias (if you wanna give), but that's good since the process doesn't start over from the start of entering the API key.\r\n\r\n## yurl\r\n\r\nCuttshort class is supported by one more class which is a URL corrector as well as checker!\r\n\r\n```python\r\nfrom CuttApi import yurl\r\na = yurl(\"google.com\").link\r\nprint(a)\r\n```\r\n\r\nThis returns `https://www.google.com/` And that happens whether you put:\r\n* google.com\r\n* http://google.com\r\n* https://google.com\r\n* google.com/\r\n* http://google.com/\r\n* https://google.com/\r\n* www.google.com\r\n* http://www.google.com\r\n* https://www.google.com\r\n* www.google.com/\r\n* http://www.google.com/\r\n* https://www.google.com/\r\n\r\n## Privacy\r\n\r\nCuttApi developer respects your privacy! The data you enter does not go over the net except to CuttLy for creations and updates. The data you enter is safely stored on your device, so that you can work on links and find them easily!\r\n\r\nPlease keep the following points in mind:\r\n* Don't delete the file to make sure you have the best experience!\r\n* The file is stored with the name as your API key, so any manual updates by the user to this file can cause the user not being able to use the latest feature!\r\n* Multiple API keys can be used on the same device!\r\n\r\n## Feedback\r\n\r\nFeedbacks are vital for any software! You say, we make, you try @ https://cutt.ly/CuttApifeedback\r\n\r\n## License\r\n\r\nMIT\r\n\r\nCopyright (c) 2024 Devraj Therani\r\n\r\nPermission 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:\r\n\r\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\r\n\r\nTHE 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.\r\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "One of the best ways of shortening URLs using Cuttly URL shortener just by entering your API key and seeing the rest that is done automatically by the Module",
    "version": "1.0.1",
    "project_urls": {
        "Download": "https://github.com/devrajdevs/CuttApi/archive/refs/tags/v1.0.1.tar.gz",
        "Homepage": "https://github.com/devrajdevs/CuttApi"
    },
    "split_keywords": [
        "api",
        " simple",
        " url",
        " shortener"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3cc9150a4fceea27d73d227c61fd0faab2626b070a1a51b3d6eda9d9cc007fbd",
                "md5": "86a3db212b1dcd354e43947e325faf51",
                "sha256": "267841c21bd546ec8bddbe8082eefbf7bec8b570ab715b08c9f720ce745181e0"
            },
            "downloads": -1,
            "filename": "cuttapi-1.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "86a3db212b1dcd354e43947e325faf51",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 6981,
            "upload_time": "2024-09-17T13:08:14",
            "upload_time_iso_8601": "2024-09-17T13:08:14.127678Z",
            "url": "https://files.pythonhosted.org/packages/3c/c9/150a4fceea27d73d227c61fd0faab2626b070a1a51b3d6eda9d9cc007fbd/cuttapi-1.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-17 13:08:14",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "devrajdevs",
    "github_project": "CuttApi",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "cuttapi"
}
        
Elapsed time: 0.33891s