Skip to main content

An unofficial python API to access Pluxee (Sodexo) balance and transactions

Project description

# Pluxee API

![Tests](https://github.com/Tib612/pluxee-api/actions/workflows/python-tests.yml/badge.svg) [![PyPI](https://img.shields.io/pypi/v/pluxee-api)](https://pypi.org/project/pluxee-api/) [![Supported Python versions](https://img.shields.io/pypi/pyversions/pluxee-api.svg)](https://pypi.org/project/pluxee-api/) [![Documentation status](https://readthedocs.org/projects/pluxee-api/badge/?version=latest)](https://pluxee-api.readthedocs.io/en/latest/?badge=latest) [![License](https://img.shields.io/pypi/l/pluxee-api)](https://github.com/tib612/pluxee-api/blob/master/LICENSE)

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.

## Features - Retrieve account balance - Fetch transaction history

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

`python pip install pluxee-api `

For asynchronous version:

`python pip install pluxee-api[async] `

Alternatively, you can clone the repository from GitHub: `python git clone git://github.com/Tib612/pluxee-api.git cd pluxee-api pip install -e . `

## 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.

## 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/

## 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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pluxee-api-0.1.0.tar.gz (10.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pluxee_api-0.1.0-py3-none-any.whl (8.9 kB view details)

Uploaded Python 3

File details

Details for the file pluxee-api-0.1.0.tar.gz.

File metadata

  • Download URL: pluxee-api-0.1.0.tar.gz
  • Upload date:
  • Size: 10.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for pluxee-api-0.1.0.tar.gz
Algorithm Hash digest
SHA256 338889d44986c3fba5d1f9dbf28787b22e37361701616b47f498fb546a27f44c
MD5 34dbdc0fc80bfcb8f7d51e166bda09a9
BLAKE2b-256 b30d6d5b8d8d7f13c96bb2379f925ecc66e538129e010c4b5f85db261d81d9c5

See more details on using hashes here.

File details

Details for the file pluxee_api-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: pluxee_api-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 8.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for pluxee_api-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ff55b7cbf98e72aec1db0b6e68ab3d97bd5091ec8c1d2c9078ac2bd95452b35e
MD5 036b8dfd47f66b20ac46689d49561a77
BLAKE2b-256 ad5454129f8cb39003b7a45871457f1188dc95f43e7bd9910a95eba09cd24e64

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page