interpals-api 2.3.1__tar.gz → 3.0__tar.gz

interpals_api-3.0/PKG-INFO

@@ -0,0 +1,151 @@
+Metadata-Version: 2.4
+Name: interpals-api
+Version: 3.0
+Summary: Unofficial Python API for interpals.net.
+Home-page: https://github.com/fomalhaut88/interpals-api
+Author: Alexander Khlebushchev
+License: MIT
+Project-URL: Homepage, https://pypi.org/project/interpals-api/
+Project-URL: Documentation, https://fomalhaut88.github.io/interpals-api/
+Project-URL: Source, https://github.com/fomalhaut88/interpals-api
+Project-URL: Issues, https://github.com/fomalhaut88/interpals-api/issues
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+Requires-Dist: aiohttp>=3.14
+Requires-Dist: requests>=2.34
+Requires-Dist: yarl>=1.25
+Dynamic: author
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# interpals-api
+
+This Python library provides a simple HTTP API for working with the website https://interpals.net/. It includes:
+
+* retrieving data by user identifier
+* listing visitors
+* searching for users by criteria
+* viewing users
+* listing albums and pictures
+
+## Installation
+
+```
+pip install interpals-api
+```
+
+## Basic example
+
+```python
+from interpals_api import login_sync, ApiSync
+
+session = login_sync('yourusername', 'yourpassword')
+api = ApiSync(session)
+
+profile = api.profile('someuser')
+print(profile)
+```
+
+Since version `2.1` it supports asynchronous calls for each api method. Below is a brief asynchronous example:
+
+```python
+from interpals_api import login_async, ApiAsync
+
+session = await login_async('yourusername', 'yourpassword')
+api = ApiAsync(session)
+
+profile = await api.profile('someuser')
+print(profile)
+```
+
+## Other examples
+
+Basic example to retrieve user info:
+
+```python
+from interpals_api import login_sync, ApiSync
+
+session = login_sync('yourusername', 'yourpassword')
+api = ApiSync(session)
+
+# This gives info of the user with the link: https://www.interpals.net/someuser
+profile = api.profile('someuser')
+```
+
+Dump and load session object:
+
+```python
+from interpals_api import login_sync, ApiSync
+
+session = login_sync('yourusername', 'yourpassword')
+
+# Save session into a file
+with open('session.txt', 'w') as f:
+    f.write(session.dumps())
+
+# Load session from the saved file
+with open('session.txt') as f:
+    session = Session.loads(f.read())
+```
+
+Viewing and searching for users:
+
+```python
+from interpals_api import login_sync, ApiSync
+from interpals_api.schemas import SearchOptions
+
+session = login_sync('yourusername', 'yourpassword')
+api = ApiSync(session)
+
+# Viewing a certain user
+api.view('someuser')
+
+# Showing the visitors of your profile
+users = api.visitors()
+print(users)
+
+# Searching for users
+options = SearchOptions(
+    age1=20,
+    age2=40,
+    sex=['male', 'female'],
+    continents=['AF', 'AS', 'EU', 'NA', 'OC', 'SA'],
+    countries=['US', 'CA', 'UK', 'RU'],
+    keywords='travelling',
+    online=True,
+    city_name='London'  # Or you can use 'city_code' with its direct code on the website (it's faster)
+)
+for user in api.search(options, limit=100, timeout=1.0):
+    print(user)
+```
+
+To work with pictures, it is necessary to use `uid` in methods:
+
+```python
+from interpals_api import login_sync, ApiSync
+
+session = login_sync('yourusername', 'yourpassword')
+api = ApiSync(session)
+
+uid = api.get_uid('someuser')
+
+albums = api.albums(uid)
+for album in albums:
+    pictures = api.pictures(uid, album.aid)
+    for picture in pictures:
+        print(picture.large)
+```

interpals_api-3.0/README.md

@@ -0,0 +1,117 @@
+# interpals-api
+
+This Python library provides a simple HTTP API for working with the website https://interpals.net/. It includes:
+
+* retrieving data by user identifier
+* listing visitors
+* searching for users by criteria
+* viewing users
+* listing albums and pictures
+
+## Installation
+
+```
+pip install interpals-api
+```
+
+## Basic example
+
+```python
+from interpals_api import login_sync, ApiSync
+
+session = login_sync('yourusername', 'yourpassword')
+api = ApiSync(session)
+
+profile = api.profile('someuser')
+print(profile)
+```
+
+Since version `2.1` it supports asynchronous calls for each api method. Below is a brief asynchronous example:
+
+```python
+from interpals_api import login_async, ApiAsync
+
+session = await login_async('yourusername', 'yourpassword')
+api = ApiAsync(session)
+
+profile = await api.profile('someuser')
+print(profile)
+```
+
+## Other examples
+
+Basic example to retrieve user info:
+
+```python
+from interpals_api import login_sync, ApiSync
+
+session = login_sync('yourusername', 'yourpassword')
+api = ApiSync(session)
+
+# This gives info of the user with the link: https://www.interpals.net/someuser
+profile = api.profile('someuser')
+```
+
+Dump and load session object:
+
+```python
+from interpals_api import login_sync, ApiSync
+
+session = login_sync('yourusername', 'yourpassword')
+
+# Save session into a file
+with open('session.txt', 'w') as f:
+    f.write(session.dumps())
+
+# Load session from the saved file
+with open('session.txt') as f:
+    session = Session.loads(f.read())
+```
+
+Viewing and searching for users:
+
+```python
+from interpals_api import login_sync, ApiSync
+from interpals_api.schemas import SearchOptions
+
+session = login_sync('yourusername', 'yourpassword')
+api = ApiSync(session)
+
+# Viewing a certain user
+api.view('someuser')
+
+# Showing the visitors of your profile
+users = api.visitors()
+print(users)
+
+# Searching for users
+options = SearchOptions(
+    age1=20,
+    age2=40,
+    sex=['male', 'female'],
+    continents=['AF', 'AS', 'EU', 'NA', 'OC', 'SA'],
+    countries=['US', 'CA', 'UK', 'RU'],
+    keywords='travelling',
+    online=True,
+    city_name='London'  # Or you can use 'city_code' with its direct code on the website (it's faster)
+)
+for user in api.search(options, limit=100, timeout=1.0):
+    print(user)
+```
+
+To work with pictures, it is necessary to use `uid` in methods:
+
+```python
+from interpals_api import login_sync, ApiSync
+
+session = login_sync('yourusername', 'yourpassword')
+api = ApiSync(session)
+
+uid = api.get_uid('someuser')
+
+albums = api.albums(uid)
+for album in albums:
+    pictures = api.pictures(uid, album.aid)
+    for picture in pictures:
+        print(picture.large)
+```

interpals_api-3.0/interpals_api/__init__.py

@@ -0,0 +1,125 @@
+"""
+# interpals-api
+
+This Python library provides a simple HTTP API for working with the website
+https://interpals.net/. It includes:
+
+* retrieving data by user identifier
+* listing visitors
+* searching for users by criteria
+* viewing users
+* listing albums and pictures
+
+## Installation
+
+```
+pip install interpals-api
+```
+
+## Basic example
+
+```python
+from interpals_api import login_sync, ApiSync
+
+session = login_sync('yourusername', 'yourpassword')
+api = ApiSync(session)
+
+profile = api.profile('someuser')
+print(profile)
+```
+
+Since version `2.1` it supports asynchronous calls for each api method. Below
+there is a brief asynchronous example:
+
+```python
+from interpals_api import login_async, ApiAsync
+
+session = await login_async('yourusername', 'yourpassword')
+api = ApiAsync(session)
+
+profile = await api.profile('someuser')
+print(profile)
+```
+
+## Other examples
+
+Basic example to retrieve user info:
+
+```python
+from interpals_api import login_sync, ApiSync
+
+session = login_sync('yourusername', 'yourpassword')
+api = ApiSync(session)
+
+# This gives info of the user with the link: https://www.interpals.net/someuser
+profile = api.profile('someuser')
+```
+
+Dump and load session object:
+
+```python
+from interpals_api import login_sync, ApiSync
+
+session = login_sync('yourusername', 'yourpassword')
+
+# Save session into a file
+with open('session.txt', 'w') as f:
+    f.write(session.dumps())
+
+# Load session from the saved file
+with open('session.txt') as f:
+    session = Session.loads(f.read())
+```
+
+Viewing and searching for users:
+
+```python
+from interpals_api import login_sync, ApiSync
+from interpals_api.schemas import SearchOptions
+
+session = login_sync('yourusername', 'yourpassword')
+api = ApiSync(session)
+
+# Viewing a certain user
+api.view('someuser')
+
+# Showing the visitors of your profile
+users = api.visitors()
+print(users)
+
+# Searching for users
+options = SearchOptions(
+    age1=20,
+    age2=40,
+    sex=['male', 'female'],
+    continents=['AF', 'AS', 'EU', 'NA', 'OC', 'SA'],
+    countries=['US', 'CA', 'UK', 'RU'],
+    keywords='travelling',
+    online=True,
+    city_name='London'  # Or you can use 'city_code' with its direct code on
+                        # the website (it's faster)
+)
+for user in api.search(options, limit=100, timeout=1.0):
+    print(user)
+```
+
+To work with pictures, it is necessary to use `uid` in methods:
+
+```python
+from interpals_api import login_sync, ApiSync
+
+session = login_sync('yourusername', 'yourpassword')
+api = ApiSync(session)
+
+uid = api.get_uid('someuser')
+
+albums = api.albums(uid)
+for album in albums:
+    pictures = api.pictures(uid, album.aid)
+    for picture in pictures:
+        print(picture.large)
+```
+"""
+
+from .session import Session, login_sync, login_async  # noqa: F401
+from .api import ApiSync, ApiAsync  # noqa: F401