boonli-api


Nameboonli-api JSON
Version 0.1.4 PyPI version JSON
download
home_pagehttps://github.com/beaufour/boonli_api
SummaryAPI allowing you to fecth menus from boonli.com
upload_time2022-12-20 17:35:10
maintainer
docs_urlNone
authorAllan Beaufour
requires_python>=3.7,<4.0
licenseApache-2.0
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Boonli API

[![pre-commit](https://github.com/beaufour/boonli_api/actions/workflows/pre-commit.yml/badge.svg)](https://github.com/beaufour/boonli_api/actions/workflows/pre-commit.yml) [![pre-commit](https://github.com/beaufour/boonli_api/actions/workflows/pre-commit.yml/badge.svg)](https://github.com/beaufour/boonli_api/actions/workflows/pre-commit.yml) [![Coverage Status](https://coveralls.io/repos/github/beaufour/boonli_api/badge.svg?branch=main)](https://coveralls.io/github/beaufour/boonli_api?branch=main) [![PyPI version](https://badge.fury.io/py/boonli_api.svg)](https://badge.fury.io/py/boonli_api)

This API allows you to retrieve the menus that were chosen on [Boonli](https://boonli.com).

## Usage

To get the menu information run:

    > boonli_api/api.py -c <customer_id> -u <username> -p <password>

Where `customer_id` is the first part of the domain name where you login, like `my_school` in `https://myschool.boonli.com`.

To enable a lot of debug logging you can add `-v`.

## Web API

I have also created an API that can be deployed on Google Cloud Function that returns the menus as an iCalendar here: <https://github.com/beaufour/boonli_calendar>

## Notes

Boonli does not have an official API, so I reverse engineered it. It involves parsing two web pages which is always fragile. So it will probably break at some point.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/beaufour/boonli_api",
    "name": "boonli-api",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7,<4.0",
    "maintainer_email": "",
    "keywords": "",
    "author": "Allan Beaufour",
    "author_email": "allan@beaufour.dk",
    "download_url": "https://files.pythonhosted.org/packages/8d/9b/817c0ea5e6757ada5d2fbe4096ad653019e352e50d5bcd383e82b85887d7/boonli_api-0.1.4.tar.gz",
    "platform": null,
    "description": "# Boonli API\n\n[![pre-commit](https://github.com/beaufour/boonli_api/actions/workflows/pre-commit.yml/badge.svg)](https://github.com/beaufour/boonli_api/actions/workflows/pre-commit.yml) [![pre-commit](https://github.com/beaufour/boonli_api/actions/workflows/pre-commit.yml/badge.svg)](https://github.com/beaufour/boonli_api/actions/workflows/pre-commit.yml) [![Coverage Status](https://coveralls.io/repos/github/beaufour/boonli_api/badge.svg?branch=main)](https://coveralls.io/github/beaufour/boonli_api?branch=main) [![PyPI version](https://badge.fury.io/py/boonli_api.svg)](https://badge.fury.io/py/boonli_api)\n\nThis API allows you to retrieve the menus that were chosen on [Boonli](https://boonli.com).\n\n## Usage\n\nTo get the menu information run:\n\n    > boonli_api/api.py -c <customer_id> -u <username> -p <password>\n\nWhere `customer_id` is the first part of the domain name where you login, like `my_school` in `https://myschool.boonli.com`.\n\nTo enable a lot of debug logging you can add `-v`.\n\n## Web API\n\nI have also created an API that can be deployed on Google Cloud Function that returns the menus as an iCalendar here: <https://github.com/beaufour/boonli_calendar>\n\n## Notes\n\nBoonli does not have an official API, so I reverse engineered it. It involves parsing two web pages which is always fragile. So it will probably break at some point.\n",
    "bugtrack_url": null,
    "license": "Apache-2.0",
    "summary": "API allowing you to fecth menus from boonli.com",
    "version": "0.1.4",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "f72824ec73b68e4769fbfd6a03e07d91",
                "sha256": "6ae0174dfcaa06ea10ff9b8b91affc7583ffa91d645b4ff9243a5aac85af8c24"
            },
            "downloads": -1,
            "filename": "boonli_api-0.1.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f72824ec73b68e4769fbfd6a03e07d91",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7,<4.0",
            "size": 9508,
            "upload_time": "2022-12-20T17:35:08",
            "upload_time_iso_8601": "2022-12-20T17:35:08.843368Z",
            "url": "https://files.pythonhosted.org/packages/7c/24/109b8ba80c3e13b1b6fe93fb6f02ea096cf32ee618d6dced639cf176f652/boonli_api-0.1.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "ef7db4b39911af40527139ff7c5a6bef",
                "sha256": "9240d6d1b20b34d1f80e383cf7c406a1b18176730c0aade9b1975ba18784b90a"
            },
            "downloads": -1,
            "filename": "boonli_api-0.1.4.tar.gz",
            "has_sig": false,
            "md5_digest": "ef7db4b39911af40527139ff7c5a6bef",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7,<4.0",
            "size": 9275,
            "upload_time": "2022-12-20T17:35:10",
            "upload_time_iso_8601": "2022-12-20T17:35:10.019662Z",
            "url": "https://files.pythonhosted.org/packages/8d/9b/817c0ea5e6757ada5d2fbe4096ad653019e352e50d5bcd383e82b85887d7/boonli_api-0.1.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-12-20 17:35:10",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "beaufour",
    "github_project": "boonli_api",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "boonli-api"
}
        
Elapsed time: 0.01958s