LowerPines: GroupMe API Wrapper for Python
This library provides a Python wrapper around the GroupMe v3 API.
Installation
Use pip to install:
pip3 install lowerpines
Basic Usage
This requires a Access Token from the GroupMe developers site
The first step to doing anything with this library is to create a GMI object:
from lowerpines.gmi import get_gmi gmi = get_gmi(access_token='access token here')
A GMI object stores a copy of the Access Token and serves as a context for various functions. The get_gmi(access_token) method will get a GMI from the cache or create one if necessary. GMI objects also provide common functions:
for group in gmi.groups:
print(group, group.name)
for bot in gmi.bots:
print(bot, bot.group)
for chat in gmi.chats:
print(chat, chat.other_user)
test_group = gmi.groups.get(name='Testing Group')
test_bot = gmi.bots.get(group_id=test_group.group_id)
test_bot.post('Hello, world!')
GroupMe supports complex message structures, such as including GroupMe-specific emoji, pictures, etc. This information can be utilized through ComplexMessage objects:
from lowerpines.message import ImageAttach
# This will dynamically create a ComplexMessage object:
complex_message = ImageAttach('URL to GroupMe processed image here') + 'Look at my cool picture'
test_bot.post(complex_message)
The various MessageAttach objects (such as ImageAttach, EmojiAttach, etc.) will automatically convert themselves into a ComplexMessage object when added to a str or to another MessageAttach object. However, a MessageAttach object is not a ComplexMessage object, so the following is not allowed:
test_bot.post(ImageAttach('URL here')) # This will trigger an exception
The correct way to do this is to create a ComplexMessage object manually:
from lowerpines.message import ComplexMessage
complex_message = ComplexMessage(ImageAttach('URL here'))
test_bot.post(complex_message)
Viewing messages for groups is also available:
for message in test_group.messages.recent():
print(message.text)
Each message’s text is also available as a ComplexMessage object through message.complex_text
Please see the docs directory for more information.
Metadata
Release files for lowerpines 0.6.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| lowerpines-0.6.0.tar.gz | 20.2 kB | Without provenance | Details for lowerpines-0.6.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| lowerpines-0.6.0-py3-none-any.whl | Python 3 | none | any | Details for lowerpines-0.6.0-py3-none-any.whl |
Total release size: 47.0 kB
Release files / lowerpines-0.6.0.tar.gz
| Download URL | lowerpines-0.6.0.tar.gz |
|---|---|
| Size | 20.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
56bc490e2d8d7bb49d6e2722ac273ccbc412810947b01be3c8bf14021ba124a1
|
|
BLAKE2b-256 checksum How to use checksums |
0397b3b884f82f090f955568b177d9473a13ccad13353196fe4797d5862ddb08
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.7.4
|
Release files / lowerpines-0.6.0-py3-none-any.whl
| Download URL | lowerpines-0.6.0-py3-none-any.whl |
|---|---|
| Size | 26.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
71f9893683452cdcb37d15156341a65308a8322ff3cb89c2ecaeee29b45d840e
|
|
BLAKE2b-256 checksum How to use checksums |
f9ae3cc7f9e9e5372da149199e305993e4566e26c2bfa3fb2dc9c0831f13a4ed
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.7.4
|
Security for lowerpines 0.6.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.