Metadata-Version: 2.1
Name: pyshortener
Version: 1.1.0
Summary: A Python package to use the is.gd/v.gd API 
Author: Hamster45105
License: MIT License
Project-URL: Homepage, https://github.com/Hamster45105/pyshortener
Project-URL: Issues, https://github.com/Hamster45105/pyshortener/issues
Project-URL: Pull Requests, https://github.com/Hamster45105/pyshortener/pulls
Project-URL: Documentation, https://github.com/Hamster45105/pyshortener/blob/main/DOCS.md
Keywords: url shortener,is.gd,v.gd
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests ==2.32.3

# PyShortener

<div align="center">
  <img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/Hamster45105/pyshortener?style=social">
  <img alt="GitHub Repo forks" src="https://img.shields.io/github/forks/Hamster45105/pyshortener?style=social">
  <img alt="GitHub Repo forks" src="https://img.shields.io/github/watchers/Hamster45105/pyshortener?style=social">

  <br/>

  <img alt="Static Badge" src="https://img.shields.io/badge/Python-8A2BE2?style=for-the-badge&logo=python&logoColor=white&color=blue">
  <img alt="Static Badge" src="https://img.shields.io/badge/PyPI-8A2BE2?style=for-the-badge&logo=pypi&logoColor=white&color=blue">

  <br/>

  <img alt="Python version" src="https://img.shields.io/pypi/pyversions/pyshortener?logo=python&logoColor=white&label=Python Version&style=for-the-badge&color=green"/>
  <img alt="PyPI version" src="https://img.shields.io/pypi/v/pyshortener?logo=pypi&logoColor=white&style=for-the-badge&label=PyPI+Version&color=green"/>
  
  <br/>

  <img src="https://img.shields.io/github/license/Hamster45105/pyshortener?style=for-the-badge&color=blue" alt="License LGPL-3.0" />
  <img src="https://img.shields.io/github/languages/code-size/Hamster45105/pyshortener?style=for-the-badge" alt="GitHub code size in bytes" />
  <img src="https://img.shields.io/github/actions/workflow/status/Hamster45105/pyshortener/tests.yml?style=for-the-badge&color=blue&label=Tests" alt="Test staus" />
</div>

<br/>

`pyshortener` is a Python library for interacting with the is.gd and v.gd URL shortening services. It provides functions to shorten and expand URLs using these services.

## Install

You can install `pyshortener` using pip:

```bash
pip install pyshortener
```

## Documentation

Documentation is available in the [DOCS.md file](DOCS.md)

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

If you can't contribute code, then give the repo a star!

### Can I add more URL services?

Sure, if these two conditions are met:

1. The API must have be completely free,
2. The API must not require an API key,
3. The API must be in English

## License

`pyshortener` is licensed under the [MIT License](https://choosealicense.com/licenses/mit/#)
