A python wrapper around the Rest API of the Swiss Postcard creator.
# requires python 3.6 or later
$ pip install postcard-creatorfrom postcard_creator.postcard_creator import PostcardCreator
w = PostcardCreator(token)
w.get_quota()
w.get_user_info()
w.get_billing_saldo()
w.has_free_postcard()
w.send_free_card(postcard=)Log in with your SwissID credentials. Note that 2-factor authentication is not supported (See #40 (comment)).
from postcard_creator.postcard_creator import PostcardCreator, Postcard, Token, Recipient, Sender
token = Token()
token.fetch_token(username='', password='')
token.has_valid_credentials(username='', password='')
recipient = Recipient(prename='', lastname='', street='', place='', zip_code=0000)
sender = Sender(prename='', lastname='', street='', place='', zip_code=0000)
card = Postcard(message='', recipient=recipient, sender=sender, picture_stream=open('./my-photo.jpg', 'rb'))
w = PostcardCreator(token)
w.send_free_card(postcard=card, mock_send=False, image_export=False)The following keyword arguments are available for advanced configuration.
PostcardCreator#send_free_card():
image_export=False: Export postcard image to current directory (os.getcwd)mock_send=False: Do not submit order (testing)fallback_color_fill=False: On False: If image is too small, force upscale to match postcard aspect ration (background-size: contain), on True: fallback to color fill mode where image is centered and border is filled with most dominant color found in image.
import logging
logger = logging.getLogger('postcard_creator')
# log levels
# 5: trace
# 10: debug
# 20: info
# 30: warning- Postcards is a commandline interface built around this library.
- See postcard-love for more usage examples.
pip install -r requirements.txt
pip install -r requirements-dev.txt
pip install -e .
pytest- postcards - A CLI for the Swiss Postcard Creator
- postcardcreator - node.js API for the Swiss Post Postcard Creator
- add fallback_color_fill parameter in send_free_card()
- changes in internals of swissid token authentication due to introduction of anomaly-detection #41
- drop support for postcard_creator_legacy
- update legacy (username/ password) token authentication due to changed endpoints
- note: legacy method now uses postcard_creator_swissid endpoints instead of postcard_creator_legacy, postcard_creator_legacy is out of life
- update requests to v2.25.1 to fix "AttributeError: 'NoneType' object has no attribute 'group'" in authentication. #27
- support of new swissid authentication (access_token with code/ code_verifier)
- support of new endpoints at https://pccweb.api.post.ch/secure/api/mobile/v1
- class PostcardCreator is a proxy which instantiates an endpoint wrapper compatible with authentication method of token, underlying wrappers are: PostcardCreatorSwissId, PostcardCreatorLegacy
- migration to v2.0
- with authentication method swissid: if you rely on get_billing_saldo(), get_user_info(): these endpoints return data in different format
- customizations image_target_width, image_target_height, image_quality_factor no longer compatible with authentication method swissid
- require python 3.6 or later
- support for swissid authentication
- Method
Token#has_valid_credentialsandToken#fetch_tokenintroduce a parametermethodwhich can be set to one of these vals:['mixed', 'legacy', 'swissid'].'mixed'is default and tries both authentication procedures
- Migrate to postcardcreator API 2.2
- Fix issues with PNG images #6
- internal changes
- do not use requirements.txt in setup.py anymore. set all requirements in install_requires without explicit version numbers
pip install fails with the above error. Install libjpeg as discussed here
https://stackoverflow.com/questions/44043906/the-headers-or-library-files-could-not-be-found-for-jpeg-installing-pillow-on
pip install Pillow==9.5.0
Andrin Bertschi
https://twitter.com/andrinbertschi
<3