Metadata-Version: 2.1
Name: tdotly
Version: 1.0a1.dev2
Summary: This is a python package for t.ly url shortener service.
Project-URL: Homepage, https://github.com/PriomDeb/tdotly
Project-URL: Bug Tracker, https://github.com/PriomDeb/tdotly/issues
Author-email: Priom Deb <priom@priomdeb.com>
License: MIT License
        
        Copyright (c) 2022 PriomDeb
        
        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.
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.7
Requires-Dist: requests==2.28.1
Description-Content-Type: text/markdown

### This is a python package for t.ly url shortener service. Developed by [Priom Deb](https://priomdeb.com/) with supports from t.ly team.


</br>

Try the project by installing it.
```bash
pip install tdotly
```

</br>

### tdotly 1.0a1.dev1
This is a developmental release of an alpha release. You can try it now. ***The package has built-in documentation of all its methods.***
[Visit GitHub project page for more information.](https://github.com/PriomDeb/tdotly)

</br>


## Documentation

```python
from tdotly import tly

# Create an instance
short = tly.tly_shorturl()

# Initialize with your API token from t.ly account
short.initialize(user_api_token)

```


|                   Methods                           |                                    Description                                         |
|-----------------------------------------------------|----------------------------------------------------------------------------------------|
|short.create_short_url("https://example.com")        | Create a short url for a long url                                                      |
|short.short_url_stats(short_url="https://t.ly/xxxx") | Get the stats for the short url                                                        |
|short.get_short_url_info(user_short_url)             | Get information of your short url                                                      |
|short.edit_url_settings(**kwargs)                    | Update/Edit some settings of your short url                                            |
|short.delete_short_url("t.ly/xxxx")                  | Delete your short url                                                                  |
|short.expand("https://t.ly/xxxx")                    | Expand your short url to see the original long url and the expired status of short url |


</br>

***More documentation will updated soon.*** 

For any help contact the the package developer [Priom Deb](mailto:priom@priomdeb.com) or the t.ly [Support](mailto:support@t.ly).
