xdataapi 0.3.0__py3-none-any.whl

xdataapi/models/user_response.py

@@ -0,0 +1,128 @@
+from __future__ import annotations
+
+from collections.abc import Mapping
+from typing import TYPE_CHECKING, Any, TypeVar
+from uuid import UUID
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+from ..models.meta_cache import MetaCache
+from ..types import UNSET, Unset
+
+if TYPE_CHECKING:
+    from ..models.user import User
+
+
+T = TypeVar("T", bound="UserResponse")
+
+
+@_attrs_define
+class UserResponse:
+    """
+    Attributes:
+        items (int): Objects returned.
+        credits_charged (float):  Example: 20.
+        balance_remaining (float):  Example: 79980.
+        cache (MetaCache):
+        request_id (UUID):
+        next_cursor (str | Unset):
+        data (User | Unset):
+    """
+
+    items: int
+    credits_charged: float
+    balance_remaining: float
+    cache: MetaCache
+    request_id: UUID
+    next_cursor: str | Unset = UNSET
+    data: User | Unset = UNSET
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        items = self.items
+
+        credits_charged = self.credits_charged
+
+        balance_remaining = self.balance_remaining
+
+        cache = self.cache.value
+
+        request_id = str(self.request_id)
+
+        next_cursor = self.next_cursor
+
+        data: dict[str, Any] | Unset = UNSET
+        if not isinstance(self.data, Unset):
+            data = self.data.to_dict()
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "items": items,
+                "credits_charged": credits_charged,
+                "balance_remaining": balance_remaining,
+                "cache": cache,
+                "request_id": request_id,
+            }
+        )
+        if next_cursor is not UNSET:
+            field_dict["next_cursor"] = next_cursor
+        if data is not UNSET:
+            field_dict["data"] = data
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        from ..models.user import User  # noqa: PLC0415
+
+        d = dict(src_dict)
+        items = d.pop("items")
+
+        credits_charged = d.pop("credits_charged")
+
+        balance_remaining = d.pop("balance_remaining")
+
+        cache = MetaCache(d.pop("cache"))
+
+        request_id = UUID(d.pop("request_id"))
+
+        next_cursor = d.pop("next_cursor", UNSET)
+
+        _data = d.pop("data", UNSET)
+        data: User | Unset
+        if isinstance(_data, Unset):
+            data = UNSET
+        else:
+            data = User.from_dict(_data)
+
+        user_response = cls(
+            items=items,
+            credits_charged=credits_charged,
+            balance_remaining=balance_remaining,
+            cache=cache,
+            request_id=request_id,
+            next_cursor=next_cursor,
+            data=data,
+        )
+
+        user_response.additional_properties = d
+        return user_response
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

xdataapi/py.typed

@@ -0,0 +1 @@
+# Marker file for PEP 561

xdataapi/types.py

@@ -0,0 +1,54 @@
+"""Contains some shared types for properties"""
+
+from collections.abc import Mapping, MutableMapping
+from http import HTTPStatus
+from typing import IO, BinaryIO, Generic, Literal, TypeVar
+
+from attrs import define
+
+
+class Unset:
+    def __bool__(self) -> Literal[False]:
+        return False
+
+
+UNSET: Unset = Unset()
+
+# The types that `httpx.Client(files=)` can accept, copied from that library.
+FileContent = IO[bytes] | bytes | str
+FileTypes = (
+    # (filename, file (or bytes), content_type)
+    tuple[str | None, FileContent, str | None]
+    # (filename, file (or bytes), content_type, headers)
+    | tuple[str | None, FileContent, str | None, Mapping[str, str]]
+)
+RequestFiles = list[tuple[str, FileTypes]]
+
+
+@define
+class File:
+    """Contains information for file uploads"""
+
+    payload: BinaryIO
+    file_name: str | None = None
+    mime_type: str | None = None
+
+    def to_tuple(self) -> FileTypes:
+        """Return a tuple representation that httpx will accept for multipart/form-data"""
+        return self.file_name, self.payload, self.mime_type
+
+
+T = TypeVar("T")
+
+
+@define
+class Response(Generic[T]):
+    """A response from an endpoint"""
+
+    status_code: HTTPStatus
+    content: bytes
+    headers: MutableMapping[str, str]
+    parsed: T | None
+
+
+__all__ = ["UNSET", "File", "FileTypes", "RequestFiles", "Response", "Unset"]

xdataapi-0.3.0.dist-info/METADATA

@@ -0,0 +1,148 @@
+Metadata-Version: 2.4
+Name: xdataapi
+Version: 0.3.0
+Summary: Python client for the xdataapi.io API: read-only X (Twitter) profiles, tweets, threads, search.
+License: MIT
+Keywords: twitter,x,api,tweets,sdk,xdataapi
+Requires-Python: >=3.11,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Requires-Dist: attrs (>=22.2.0)
+Requires-Dist: httpx (>=0.23.1,<0.29.0)
+Project-URL: API reference, https://xdataapi.io/reference
+Project-URL: Documentation, https://xdataapi.io/docs
+Project-URL: Homepage, https://xdataapi.io
+Project-URL: Issue tracker, https://github.com/andrewchmr/xdata-api/issues
+Project-URL: Repository, https://github.com/andrewchmr/xdata-api
+Project-URL: Source code, https://github.com/andrewchmr/xdata-api
+Description-Content-Type: text/markdown
+
+# xdataapi
+A client library for accessing xdataapi.io API
+
+## Usage
+First, create a client:
+
+```python
+from xdataapi import Client
+
+client = Client(base_url="https://api.example.com")
+```
+
+If the endpoints you're going to hit require authentication, use `AuthenticatedClient` instead:
+
+```python
+from xdataapi import AuthenticatedClient
+
+client = AuthenticatedClient(base_url="https://api.example.com", token="SuperSecretToken")
+```
+
+Now call your endpoint and use your models:
+
+```python
+from xdataapi.models import MyDataModel
+from xdataapi.api.my_tag import get_my_data_model
+from xdataapi.types import Response
+
+with client as client:
+    my_data: MyDataModel = get_my_data_model.sync(client=client)
+    # or if you need more info (e.g. status_code)
+    response: Response[MyDataModel] = get_my_data_model.sync_detailed(client=client)
+```
+
+Or do the same thing with an async version:
+
+```python
+from xdataapi.models import MyDataModel
+from xdataapi.api.my_tag import get_my_data_model
+from xdataapi.types import Response
+
+async with client as client:
+    my_data: MyDataModel = await get_my_data_model.asyncio(client=client)
+    response: Response[MyDataModel] = await get_my_data_model.asyncio_detailed(client=client)
+```
+
+By default, when you're calling an HTTPS API it will attempt to verify that SSL is working correctly. Using certificate verification is highly recommended most of the time, but sometimes you may need to authenticate to a server (especially an internal server) using a custom certificate bundle.
+
+```python
+client = AuthenticatedClient(
+    base_url="https://internal_api.example.com",
+    token="SuperSecretToken",
+    verify_ssl="/path/to/certificate_bundle.pem",
+)
+```
+
+You can also disable certificate validation altogether, but beware that **this is a security risk**.
+
+```python
+client = AuthenticatedClient(base_url="https://internal_api.example.com", token="SuperSecretToken", verify_ssl=False)
+```
+
+Things to know:
+1. Every path/method combo becomes a Python module with four functions:
+    1. `sync`: Blocking request that returns parsed data (if successful) or `None`
+    1. `sync_detailed`: Blocking request that always returns a `Request`, optionally with `parsed` set if the request was successful.
+    1. `asyncio`: Like `sync` but async instead of blocking
+    1. `asyncio_detailed`: Like `sync_detailed` but async instead of blocking
+
+1. All path/query params, and bodies become method arguments.
+1. If your endpoint had any tags on it, the first tag will be used as a module name for the function (my_tag above)
+1. Any endpoint which did not have a tag will be in `xdataapi.api.default`
+
+## Advanced customizations
+
+There are more settings on the generated `Client` class which let you control more runtime behavior, check out the docstring on that class for more info. You can also customize the underlying `httpx.Client` or `httpx.AsyncClient` (depending on your use-case):
+
+```python
+from xdataapi import Client
+
+
+def log_request(request):
+    print(f"Request event hook: {request.method} {request.url} - Waiting for response")
+
+
+def log_response(response):
+    request = response.request
+    print(f"Response event hook: {request.method} {request.url} - Status {response.status_code}")
+
+
+client = Client(
+    base_url="https://api.example.com",
+    httpx_args={"event_hooks": {"request": [log_request], "response": [log_response]}},
+)
+
+# Or get the underlying httpx client to modify directly with client.get_httpx_client() or client.get_async_httpx_client()
+```
+
+You can even set the httpx client directly, but beware that this will override any existing settings (e.g., base_url):
+
+```python
+import httpx
+from xdataapi import Client
+
+client = Client(
+    base_url="https://api.example.com",
+)
+# Note that base_url needs to be re-set, as would any shared cookies, headers, etc.
+client.set_httpx_client(httpx.Client(base_url="https://api.example.com", proxies="http://localhost:8030"))
+```
+
+## Building / publishing this package
+This project uses [Poetry](https://python-poetry.org/) to manage dependencies  and packaging.  Here are the basics:
+1. Update the metadata in pyproject.toml (e.g. authors, version)
+1. If you're using a private repository, configure it with Poetry
+    1. `poetry config repositories.<your-repository-name> <url-to-your-repository>`
+    1. `poetry config http-basic.<your-repository-name> <username> <password>`
+1. Publish the client with `poetry publish --build -r <your-repository-name>` or, if for public PyPI, just `poetry publish --build`
+
+If you want to install this client into another project without publishing it (e.g. for development) then:
+1. If that project **is using Poetry**, you can simply do `poetry add <path-to-this-client>` from that project
+1. If that project is not using Poetry:
+    1. Build a wheel with `poetry build -f wheel`
+    1. Install that wheel from the other project `pip install <path-to-wheel>`
+

xdataapi-0.3.0.dist-info/RECORD

@@ -0,0 +1,61 @@
+xdataapi/__init__.py,sha256=QouaLOUqlOu79Vc_qHHKzFcyBsBqX0yHQldcRo19phw,158
+xdataapi/api/__init__.py,sha256=zTSiG_ujSjAqWPyc435YXaX9XTlpMjiJWBbV-f-YtdA,45
+xdataapi/api/account/__init__.py,sha256=5vd9uJWAjRqa9xzxzYkLD1yoZ12Ld_bAaNB5WX4fbE8,56
+xdataapi/api/account/get_me.py,sha256=nsgaK-PSPWgulKzJSJw2yGnfpQQtY8SHPozmxp9OXfc,3739
+xdataapi/api/billing/__init__.py,sha256=5vd9uJWAjRqa9xzxzYkLD1yoZ12Ld_bAaNB5WX4fbE8,56
+xdataapi/api/billing/create_checkout.py,sha256=hqscaYRAPR_9KSxTU0n1J1FvzetIT2pOJrx6KxuUnww,5915
+xdataapi/api/billing/list_packs.py,sha256=zaBDXEHhdG4a6CtspJiksAqo3vdXVUP1CPXJv1DLYG8,3774
+xdataapi/api/tweets/__init__.py,sha256=5vd9uJWAjRqa9xzxzYkLD1yoZ12Ld_bAaNB5WX4fbE8,56
+xdataapi/api/tweets/get_quotes.py,sha256=P0L6RWB1x1vQqbhIqMa4Xb7NbmbqN-nkuTV64ygfAJU,6069
+xdataapi/api/tweets/get_replies.py,sha256=SbmZHfm6vnwSC5vdJWQXHA90AcaftLoaxDWMyxTfjNE,5896
+xdataapi/api/tweets/get_retweeters.py,sha256=GrD4jFl4SeZUsGrjnUHouUsLBpx6gmwhF8jbukcsA5g,6380
+xdataapi/api/tweets/get_thread.py,sha256=EfnKvw0qjezWy0X9IrIqm_gl3Wk50TU97TlzedRD5JM,5687
+xdataapi/api/tweets/get_tweet.py,sha256=mnxuVqhINVF4YdKWfQZ6ZZMkUO_J-ViQHDbQI-UBv_Y,5046
+xdataapi/api/tweets/get_tweets.py,sha256=_zjhvfmKNCYgoRqAW6LH3uGdoPT94gjno4Ue8OJHtcQ,6012
+xdataapi/api/tweets/search_tweets.py,sha256=JrClvJMljvx0-2aWfhumORzTQe4hZYAMf22z3BhK7xs,8369
+xdataapi/api/users/__init__.py,sha256=5vd9uJWAjRqa9xzxzYkLD1yoZ12Ld_bAaNB5WX4fbE8,56
+xdataapi/api/users/get_follower_ids.py,sha256=EYCIuJLbPTx-iRqw_iIBAHf-GZjwXE8urps5JbiqW4I,6975
+xdataapi/api/users/get_followers.py,sha256=1Lzy3h83sZ_1_AL47Q7aGqm8yPY3cV_wxm4oxyA_zvs,6976
+xdataapi/api/users/get_following.py,sha256=1COzpqCB7qUIgze4utSp6VgHlOctgRyy-SQUTEcl2SM,6348
+xdataapi/api/users/get_user.py,sha256=zSb7f4okSoLQtEuHJZN3X8THQDGOfR5b5FMazUgGIyA,5184
+xdataapi/api/users/get_user_tweets.py,sha256=kJYiu31_GABTqj-2oLkL0K3lOKG1rlOgItvE_3cAWmo,6112
+xdataapi/api/users/get_users.py,sha256=jtC3ntq7csFgK212ff2JzcDydv1FNaO4k8ivfSWUqwc,6575
+xdataapi/client.py,sha256=fwU0xJF8ktG6_uvCFZh3I6Lqsmg3WKP89ODUdTunB1A,12306
+xdataapi/errors.py,sha256=gO8GBmKqmSNgAg-E5oT-oOyxztvp7V_6XG7OUTT15q0,546
+xdataapi/models/__init__.py,sha256=QUyh-9L8mH8AhJn1wN2XIVg2w2bks8Vz_YWzGDdo0CY,2009
+xdataapi/models/batch_error.py,sha256=5c1p87xFpAcmosBD8J9zrZaNEVbOPqgzCO5Ah9C3LE0,1926
+xdataapi/models/batch_error_code.py,sha256=CgMjWb4LdQwQ26x7SlyKYw6VHhQh8CogEK6EOWBlawU,408
+xdataapi/models/batch_meta.py,sha256=X1nt0z3RSaNo1_LTQRimYl_fmUckYUpAymy908kiUh4,3442
+xdataapi/models/batch_meta_cache.py,sha256=Exq5wZTnyKFfbSs9ZejV09GvAKmcPqbuKLZ173q469s,196
+xdataapi/models/create_checkout_body.py,sha256=rCQNmalTHNouVAX0itvqaizY0oMXO_OKga6lFPavRQ8,1650
+xdataapi/models/create_checkout_body_pack.py,sha256=36kD5qRrT15ZT9Juterr2_7eIrcPRz8rN6DoOJsHuTc,218
+xdataapi/models/create_checkout_response_200.py,sha256=Hm7bJis9PSFDy6f27dBC-jRGsTXkxwFQJcRhVo5ISog,2551
+xdataapi/models/error.py,sha256=J1WrOZpDFn-wNucyK10XoaxWZuGBqE5eY-_OIxerCPQ,2124
+xdataapi/models/error_body.py,sha256=IKCUz7cOAs767WdrGi9qIOS_d42wsSdxxiZi4kOMNr8,1800
+xdataapi/models/error_body_code.py,sha256=2reEFuymqk1PF3NhNvhLHy_tyut7z3KtJ6puLHiQwDA,659
+xdataapi/models/get_me_response_200.py,sha256=tLgdQkW66ezGKUDXGNENLfjc3hsQD8jHyz67z-k_evs,2498
+xdataapi/models/get_tweets_body.py,sha256=PJD-VHOj5JrGp-gSsVUwqt9oGFa3zSFm5J9LOJPJ8Fw,1552
+xdataapi/models/get_users_body.py,sha256=5oaDJ_A836INx07FV2qHGLfw4UVjA9lTfWe65pyefvY,1583
+xdataapi/models/id_page.py,sha256=kTjvM7LsAEnRlSCQJ0L7NUUOyGUhGGCRUrGGYaj1yaM,3191
+xdataapi/models/list_packs_response_200.py,sha256=E635ITRm9_GNbKXeywmBgyExsl6ANNeGQqAqiW8hqs4,3747
+xdataapi/models/list_packs_response_200_data_item.py,sha256=evw1D4f4z1vgXd2qRJgzaNJn0FNOnR8n8X5k8GOVw84,2390
+xdataapi/models/list_packs_response_200_rate_limits_item.py,sha256=AVVOr_j8vVXoV8UX3BrAkNas2oYZZvH5uh2GBs90V7g,2120
+xdataapi/models/media.py,sha256=7y8OWYzyJpkIQuxh0fpo5wAi-pX1B_V6yCn1XB-FlOA,2470
+xdataapi/models/media_type.py,sha256=MPhc3j-dh4xC00zn0hRqb9RiaPNaLDGwC7yfSXNI0g8,189
+xdataapi/models/meta.py,sha256=sUMHE7b5xedqcbmB5gcOfNeZ8SaDvOSvjGUjD2NRq0c,2813
+xdataapi/models/meta_cache.py,sha256=tBiOJVdOASCyBaD6tOiLd1EjTHxYhT_K1BW-As2ef_s,171
+xdataapi/models/problem.py,sha256=yJ5m5GGwzqVmqYEeQQLa7DMu2uKMwxbZgZAS7mYZi4g,3713
+xdataapi/models/search_tweets_product.py,sha256=la70KgvDUoOI9r-LWJzxkomidu8Ods5Gb7PTs8Kv5l0,229
+xdataapi/models/tweet.py,sha256=zFTP7VVk-0PjJmZsuAL-R4sko5vUhCDajETioVT8PzI,8928
+xdataapi/models/tweet_batch.py,sha256=ahtt_hcJU58kjf1hVrDvuuXJWZariuBA3T1BUBS7OjE,4283
+xdataapi/models/tweet_page.py,sha256=Gf8A6QBYL52DF9lrdE43Ir0B9Y28MI8u7quRmk2U-jE,3667
+xdataapi/models/tweet_response.py,sha256=FIhcL6BUBVBtlCPCYfQYJMyvHvoC0r-U9nKM824PGxs,3459
+xdataapi/models/user.py,sha256=7KNWqnzk_E5Z0WNHWhcWGfj3l1r-6cRlcXzPnDmUERw,5317
+xdataapi/models/user_batch.py,sha256=JnQumQQt9iseYZwaoMKqMhK41uyM675enX7r5lj4940,4272
+xdataapi/models/user_page.py,sha256=6rGlWZ5GrnWJ0BbMiPLjvYgls6SgxW-Ct5CZ4d1V5Dw,3654
+xdataapi/models/user_response.py,sha256=_l1k9LEyy0nmiyPlxmBqBFLZn9PuUXDlgER6ORT6cDw,3446
+xdataapi/py.typed,sha256=8ZJUsxZiuOy1oJeVhsTWQhTG_6pTVHVXk5hJL79ebTk,25
+xdataapi/types.py,sha256=0We4NPvhIYASRpQ3le41nmJeEAVm42-2VKdzlJ4Ogok,1343
+xdataapi-0.3.0.dist-info/METADATA,sha256=hUCx1T6AM5XaP9RcCO6p_LF-O2DOcxMyPKZLpOz_Aaw,5978
+xdataapi-0.3.0.dist-info/WHEEL,sha256=L-WvLdSBvJWHXv5zrQxDvNRnIgoBzLUpcbuiw19KCuQ,88
+xdataapi-0.3.0.dist-info/RECORD,,

xdataapi-0.3.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 2.5.0
+Root-Is-Purelib: true
+Tag: py3-none-any