pluxee-api

Pluxee API

The pluxee-api Python library (unofficial) provides easy access to Pluxee (Sodexo) balance and transaction data. This library allows users to retrieve information such as account balances and transaction history from the Pluxee platform. It offers both synchronous and asynchronous versions for installation.

:warning: Belgium only: I could only test this package using my belgian Sodexo card. It should not work for other countries. You can contact me if you need it to work for another country. I will happily improve this package with your help.

Features

• Retrieve account balance
• Fetch transaction history

Installation

You can install pluxee-api via pip For normal install:

pip install pluxee-api

For asynchronous version:

pip install pluxee-api[async]

Alternatively, you can clone the repository from GitHub:

git clone git://github.com/Tib612/pluxee-api.git
cd pluxee-api
pip install -e ".[dev]"

You may use a virtual env before install the package:

python -m venv venv
source venv/bin/activate
pip install --upgrade pip

Usage

To use the pluxee-api library, you need to provide your Pluxee username and password or set them as environment variables PLUXEE_USERNAME and PLUXEE_PASSWORD. No registration of keys is required.

You can find examples in the example folder.

Testing and guidelines

Testing and guidelines can be found in the GUIDELINES file.

Documentation

Documentation for pluxee-api is available at https://pluxee-api.readthedocs.io/en/latest/

Questions, Comments, etc?

If you have any questions, comments, or suggestions regarding pluxee-api, feel free to contact me on LinkedIn https://www.linkedin.com/in/thibaut-capuano/

Known issues

Known issues can be found here: https://github.com/Tib612/pluxee-api/wiki#known-issues

Contributing

Contributions to pluxee-api are welcome! Whether it's adding features, fixing bugs, or improving documentation, your contributions are appreciated. Simply fork the repository, make your changes, and submit a pull request. Let's make accessing Pluxee data easier together!

License

This project is licensed under the MIT License