Skip to main content

A Python wrapper for interacting with the Kroky meal service website.

Project description

Kroky Library

Overview

The Kroky Library is a Python package designed to help you select meal true code for easier customization (auto meal selection) and auto login. This documentation provides an overview of the library's functionality, installation instructions, and usage examples.

Installation

To install the Kroky Library, use pip:

pip install kroky-library

Usage

Initialize kroky

from kroky import Kroky

login = Kroky(username:str, password:str)

Get meals

print(login.get_menu(pos))

Select meal

print(login.select_meal(date, id))

Functions

get_menu(pos)

  • Description: [Displays all meals in selected week]
  • Parameters:
    • pos (int): [pos is week defining -1 is last week, 0 is current week, 1 is next week]
  • Returns: [return json]

select_meal(date, id)

  • Description: [Can select specific meal on specific day]
  • Parameters:
    • date (str): [date needs to be entered in this form YYYY-MM-DD]
    • date (int): [id can be get from html on kroky website (alternative will be added shortly)]
  • Returns: [Returns if meal was selected seccessfuly or not]

Contributing

If you would like to contribute to the Kroky Library, please follow these steps:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature-branch).
  3. Make your changes.
  4. Commit your changes (git commit -m 'Add new feature').
  5. Push to the branch (git push origin feature-branch).
  6. Create a new Pull Request.

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Contact

For any questions or issues, please open an issue on the GitHub repository.

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

kroky-0.1.0.tar.gz (3.3 kB view details)

Uploaded Source

Built Distribution

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

kroky-0.1.0-py3-none-any.whl (3.5 kB view details)

Uploaded Python 3

File details

Details for the file kroky-0.1.0.tar.gz.

File metadata

  • Download URL: kroky-0.1.0.tar.gz
  • Upload date:
  • Size: 3.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.3

File hashes

Hashes for kroky-0.1.0.tar.gz
Algorithm Hash digest
SHA256 583ee80ab8fb350d359703ab8f8e143d1c4d76227ec4ec1809d7b334cffb0f47
MD5 854c8bba509abe7b1924b5eed932a624
BLAKE2b-256 13a4229c06a70633bb67ae1f82fac14ad0ef5e0ce9cd306e2135baf5ca05322c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: kroky-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 3.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.3

File hashes

Hashes for kroky-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c875876f4f8e39045e592c240e78d88050c643e0265278b5b655c0f02dd455c9
MD5 7e43d13987888ff7f26632851661369b
BLAKE2b-256 f98ebf68cde90cb7cde6ce63f901db975b2c4477dfbd3e875fd5ff9577b0614d

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