cataas 0.1.0__py3-none-any.whl

cataas/__init__.py

@@ -0,0 +1,2 @@
+from .core import cat, catgif, catgif_says, cats, catsays, count, tags
+from .premade import filtercat, randomtype

cataas/core.py

@@ -0,0 +1,177 @@
+import requests
+import sys, io
+from urllib.parse import quote
+sys.stdout = io.TextIOWrapper(sys.stdout.detach(), encoding='utf-8')
+
+base_url = 'https://cataas.com'
+
+def cat(tag=None, width=None, height=None, filter=None, **kwargs) -> str:
+    """_summary_
+
+    Args:
+        tag (_type_, optional): _description_. Defaults to None.
+        width (_type_, optional): _description_. Defaults to None.
+        height (_type_, optional): _description_. Defaults to None.
+        filter (_type_, optional): _description_. Defaults to None.
+
+    Returns:
+        str: _Cat image URL_
+    """
+    if tag and tag == str:
+        request_url = f'{base_url}/cat/{quote(tag)}'
+    else:
+        request_url = f'{base_url}/cat'
+
+    raw_params = {
+        'width': width,
+        'height': height,
+        'filter': filter,
+        'json': 'true',
+        **kwargs
+    }
+    params = {k: v for k, v in raw_params.items() if v is not None}
+    response = requests.get(request_url, params=params)
+
+    response.raise_for_status()
+
+    data = response.json()
+    url = data['url']
+    return url
+
+def catgif(**kwargs) -> str:
+    """
+    Returns a random cat gif URL.
+    """
+    request_url = f'{base_url}/cat/gif'
+
+    raw_params = {
+        'json': 'true',
+        **kwargs
+    }
+    params = {k: v for k, v in raw_params.items() if v is not None}
+    response = requests.get(request_url, params=params)
+
+    response.raise_for_status()
+
+    data = response.json()
+    url = data['url']
+    return url
+
+def catgif_says(text: str, fontColor=None, fontSize=None, filter=None, **kwargs) -> str:
+    """_summary_
+
+    Args:
+        text (str): _description_
+        fontColor (_type_, optional): _description_. Defaults to None.
+        fontSize (_type_, optional): _description_. Defaults to None.
+        filter (_type_, optional): _description_. Defaults to None.
+
+    Returns:
+        str: _Cat gif saying text URL_
+    """
+    request_url = f'{base_url}/cat/gif/says/{quote(text)}'
+
+    raw_params = {
+        'fontColor': fontColor,
+        'fontSize': fontSize,
+        'filter': filter,
+        'json': 'true',
+        **kwargs
+    }
+    params = {k: v for k, v in raw_params.items() if v is not None}
+    response = requests.get(request_url, params=params)
+
+    response.raise_for_status()
+
+    data = response.json()
+    url = data['url']
+    return url
+
+def catsays(text: str, tag=None, width=None, height=None, filter=None, **kwargs) -> str:
+    """_summary_
+
+    Args:
+        tag (_type_, optional): _description_. Defaults to None.
+        width (_type_, optional): _description_. Defaults to None.
+        height (_type_, optional): _description_. Defaults to None.
+        filter (_type_, optional): _description_. Defaults to None.
+
+    Returns:
+        str: _Cat image URL_
+    """
+    if tag and tag == str:
+        request_url = f'{base_url}/cat/{quote(tag)}/says/{quote(text)}'
+    else:
+        request_url = f'{base_url}/cat/says/{text}'
+
+    raw_params = {
+        'width': width,
+        'height': height,
+        'filter': filter,
+        'json': 'true',
+        **kwargs
+    }
+    params = {k: v for k, v in raw_params.items() if v is not None}
+    response = requests.get(request_url, params=params)
+
+    response.raise_for_status()
+
+    data = response.json()
+    url = data['url']
+    return url
+
+def cats(limit: int, tags: list[str] = None, **kwargs) -> list[str]:
+    """_summary_
+
+    Args:
+        limit (int): _description_
+        tags (list[str], optional): _description_. Defaults to None.
+
+    Returns:
+        list[str]: _List of cat images_
+    """
+    request_url = f'{base_url}/api/cats'
+
+    raw_params = {
+        'limit': limit,
+        'json': 'true',
+        **kwargs
+    }
+    if tags and tags == str:
+        formatted_tags = ','.join(tags)
+        raw_params['tags'] = formatted_tags
+    params = {k: v for k, v in raw_params.items() if v is not None}
+    response = requests.get(request_url, params=params)
+
+    response.raise_for_status()
+
+    data = response.json()
+    urls = [f'{base_url}/cat/{cat['id']}' for cat in data]
+    return urls
+
+def count(print_amount: bool = False):
+    """Returns the amount of cats uploaded in the CataaS REST API"""
+    request_url = f'{base_url}/api/count'
+    response = requests.get(request_url)
+    response.raise_for_status()
+
+    data = response.json()
+    amount = data['count']
+
+    if print_amount == True:
+        print(f'Amount of cats uploaded: {amount}')
+    else:
+        return amount
+    
+def tags(print_amount: bool = False):
+    """Returns all tags that have been used in uploaded cat images (note that this will be very big)"""
+    request_url = f'{base_url}/api/tags'
+    response = requests.get(request_url)
+    response.raise_for_status()
+
+    alltags: list[str] = response.json()
+    
+    if print_amount == True:
+        print(f'All tags in uploaded cats: {alltags}')
+    else:
+        return alltags

cataas/premade.py

@@ -0,0 +1,33 @@
+import requests
+import random
+
+base_url = 'https://cataas.com'
+json_headers = {'Accept': 'application/json'}
+
+def randomtype():
+    """Returns a cat image with a random shape type"""
+    types = [
+        'square',
+        'medium',
+        'small',
+        'xsmall'
+    ]
+    response = requests.get(f'{base_url}/cat?type={random.choice(types)}', headers=json_headers)
+    response.raise_for_status()
+
+    data = response.json()
+    url = data['url']
+    return url
+
+def filtercat():
+    """Returns a cat image with either the mono filter or negate filter"""
+    filters = [
+        'mono',
+        'negate'
+    ]
+    response = requests.get(f'{base_url}/cat?filter={random.choice(filters)}', headers=json_headers)
+    response.raise_for_status()
+
+    data = response.json()
+    url = data['url']
+    return url

cataas-0.1.0.dist-info/METADATA

@@ -0,0 +1,72 @@
+Metadata-Version: 2.4
+Name: cataas
+Version: 0.1.0
+Summary: A unofficial Python wrapper for the CataaS REST API.
+Author-email: happycappa <280617573+happycappa@users.noreply.github.com>
+License: MIT
+Project-URL: Homepage, https://github.com/happycappa/cataas
+Project-URL: Source, https://github.com/happycappa/cataas/tree/main/src/cataas
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.34.2
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Dynamic: license-file
+
+# Unofficial CataaS Python Wrapper
+This is an unofficial Python wrapper for the CataaS _(Cat as a Service)_ REST API.  
+Here is it's offical website: https://cataas.com/
+
+I created this since i'm pretty bored and I don't wanna keep having to use the python [requests](https://github.com/psf/requests) package everytime I want to use the CataaS API!
+
+## Why would I want to use this?
+You can use this, like me, to have a shortcut on using the CataaS API in Python without needing to  
+import the [requests](https://github.com/psf/requests) library everytime, which i'd say is a better upgrade than the harder way.
+
+# Usage
+Here's some examples on how to use this package:
+
+1. Getting a cat image
+```python
+import cataas
+
+cat = cataas.cat()
+print(cat)
+
+# Returns a normal cat image by URL
+
+cat = cataas.catsays('Hello world!')
+print(cat)
+
+# Returns a cat image that has text by URL
+# Filters are supported too!
+
+cat = cataas.cat(width=500, height=700) # Kwargs are included
+print(cat)
+
+# Returns a cat image thats (probably) exactly 500 by 700 pixels!
+```
+
+2. Getting a cat gif
+```python
+import cataas
+
+cat = cataas.catgif()
+print(cat)
+
+# Returns a normal cat gif by URL
+# Note: The normal catgif function doesn't support filters, but the says version does!
+
+cat = cataas.catgif_says('Hello world!')
+print(cat)
+
+# Returns a cat gif that has text by URL
+```
+
+Other functions are included too but i'm too lazy to explain them.
+
+# Credits
+
+1. me (happycappa)  
+2. no one else (this is a solo package)

cataas-0.1.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+cataas/__init__.py,sha256=nTY0EBdZv9seXcuS0VmzJmCUi6MaRTLVFepGvlkcrOQ,114
+cataas/core.py,sha256=2oc1G8X58VmK855lYZTdd-xsK0WWX1Cc8VbdGtX5Quk,5073
+cataas/premade.py,sha256=2yd7yp3DoAy62g5nyI3H6tPM8mpV15ldxSQ5cRSCuks,844
+cataas-0.1.0.dist-info/licenses/LICENSE,sha256=6zogNZM0Od9p4HkkeGWcOn8IK4Aj3wP4KcU6QpsrgkU,1088
+cataas-0.1.0.dist-info/METADATA,sha256=FUvEhocNDrG4YhgQna657vaDHB-4U2j0FSyjsquWO_o,2104
+cataas-0.1.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+cataas-0.1.0.dist-info/top_level.txt,sha256=_-dAgmny_jSSCB2FOmrcJ-290T1g1u1avfnXjadqAws,7
+cataas-0.1.0.dist-info/RECORD,,

cataas-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

cataas-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 happycappa
+
+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.

cataas-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+cataas