# Pluxee API
[](https://pypi.org/project/pluxee-api/)
[](https://pypi.org/project/pluxee-api/)
[](https://pluxee-api.readthedocs.io/en/latest/?badge=latest)
[](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.
> :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:
```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 ".[dev]"
```
You may use a virtuel env before install the package:
```python
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.
## 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
Raw data
{
"_id": null,
"home_page": null,
"name": "pluxee-api",
"maintainer": "Thibaut Capuano",
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "pluxee, sodexo, api, scraping",
"author": "Thibaut Capuano",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/bf/a0/b2474e8fb2674e9082ae8f89f1f40c0458c5a254a2de92efbee8d5618d18/pluxee_api-0.2.1.tar.gz",
"platform": null,
"description": "# Pluxee API\n\n\n[](https://pypi.org/project/pluxee-api/)\n[](https://pypi.org/project/pluxee-api/)\n[](https://pluxee-api.readthedocs.io/en/latest/?badge=latest)\n[](https://github.com/tib612/pluxee-api/blob/master/LICENSE)\n\n\nThe 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.\n\n> :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.\n\n## Features\n- Retrieve account balance\n- Fetch transaction history\n\n## Installation\nYou can install pluxee-api via pip\nFor normal install:\n\n```python\npip install pluxee-api\n```\n\nFor asynchronous version:\n\n```python\npip install pluxee-api[async]\n```\n\nAlternatively, you can clone the repository from GitHub:\n```python\ngit clone git://github.com/Tib612/pluxee-api.git\ncd pluxee-api\npip install -e \".[dev]\"\n```\n\nYou may use a virtuel env before install the package:\n```python\npython -m venv venv\nsource venv/bin/activate\npip install --upgrade pip\n```\n\n\n## Usage\n\nTo 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.\n\nYou can find examples in the example folder.\n\n## Documentation\n\nDocumentation for pluxee-api is available at https://pluxee-api.readthedocs.io/en/latest/\n\n## Questions, Comments, etc?\nIf you have any questions, comments, or suggestions regarding pluxee-api, feel free to contact me on LinkedIn https://www.linkedin.com/in/thibaut-capuano/\n\n## Known issues\nKnown issues can be found here: https://github.com/Tib612/pluxee-api/wiki#known-issues\n\n## Contributing\nContributions 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!\n\n\n## License\nThis project is licensed under the MIT License\n",
"bugtrack_url": null,
"license": null,
"summary": "An unofficial python API to access Pluxee (Sodexo) balance and transactions",
"version": "0.2.1",
"project_urls": {
"Documentation": "https://pluxee-api.readthedocs.io/en/latest/",
"Homepage": "https://github.com/Tib612/pluxee-api",
"Issues": "https://github.com/Tib612/pluxee-api/issues"
},
"split_keywords": [
"pluxee",
" sodexo",
" api",
" scraping"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f25596d724fea2581bb2e1176b0d9e16725423be3a4f83eaeedb56e0144e9187",
"md5": "9d189866a597519a26ab5c18da99731c",
"sha256": "1e713c895c150751193e092e5dfad232420e150ce23665f884b8bc120a2b52f0"
},
"downloads": -1,
"filename": "pluxee_api-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9d189866a597519a26ab5c18da99731c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 17053,
"upload_time": "2024-07-22T19:09:13",
"upload_time_iso_8601": "2024-07-22T19:09:13.002650Z",
"url": "https://files.pythonhosted.org/packages/f2/55/96d724fea2581bb2e1176b0d9e16725423be3a4f83eaeedb56e0144e9187/pluxee_api-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bfa0b2474e8fb2674e9082ae8f89f1f40c0458c5a254a2de92efbee8d5618d18",
"md5": "3cb2ab7e92081b794db35538882c8bb5",
"sha256": "5803087d9ad67315b04e64f8090fbdeff411ca0e932b2b114814f0c63266f563"
},
"downloads": -1,
"filename": "pluxee_api-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "3cb2ab7e92081b794db35538882c8bb5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 18688,
"upload_time": "2024-07-22T19:09:14",
"upload_time_iso_8601": "2024-07-22T19:09:14.967244Z",
"url": "https://files.pythonhosted.org/packages/bf/a0/b2474e8fb2674e9082ae8f89f1f40c0458c5a254a2de92efbee8d5618d18/pluxee_api-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-22 19:09:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Tib612",
"github_project": "pluxee-api",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "requests",
"specs": [
[
"==",
"2.31.0"
]
]
},
{
"name": "BeautifulSoup4",
"specs": [
[
"==",
"4.12.3"
]
]
},
{
"name": "pyopenssl",
"specs": [
[
"==",
"24.2.1"
]
]
},
{
"name": "cryptography",
"specs": [
[
"==",
"42.0.2"
]
]
},
{
"name": "certifi",
"specs": []
}
],
"tox": true,
"lcname": "pluxee-api"
}
JSON
