Metadata-Version: 2.4
Name: cardo-python-utils
Version: 0.5.4
Summary: Python library enhanced with a wide range of functions for different scenarios.
Author-email: CardoAI <hello@cardoai.com>
License: MIT
Project-URL: Homepage, https://github.com/CardoAI/cardo-python-utils
Project-URL: Repository, https://github.com/CardoAI/cardo-python-utils.git
Project-URL: Issues, https://github.com/CardoAI/cardo-python-utils/issues
Keywords: utilities,helpers,django
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Requires-Python: >=3.8
Description-Content-Type: text/x-rst
License-File: LICENSE
Provides-Extra: django-keycloak
Requires-Dist: PyJWT>=2.10.1; extra == "django-keycloak"
Requires-Dist: mozilla-django-oidc>=4.0.1; extra == "django-keycloak"
Requires-Dist: requests; extra == "django-keycloak"
Provides-Extra: django-keycloak-groups
Requires-Dist: python-keycloak>=5.8.1; extra == "django-keycloak-groups"
Provides-Extra: all
Requires-Dist: PyJWT>=2.10.1; extra == "all"
Requires-Dist: mozilla-django-oidc>=4.0.1; extra == "all"
Requires-Dist: python-keycloak>=5.8.1; extra == "all"
Requires-Dist: requests; extra == "all"
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == "dev"
Requires-Dist: pytest-django>=4.5; extra == "dev"
Requires-Dist: coverage>=6.0; extra == "dev"
Requires-Dist: tox>=3.25; extra == "dev"
Dynamic: license-file

============================
CardoAI Python Helper Module
============================

This library allows the utilization of different utility functions for different scenarios.

Main utils:

* time
* string
* data_structures
* db
* django
* math
* exception
* choices


Quick start
-----------
1. Import wanted function like this::

    from python_utils.time import date_range
    date_range(start_date, end_date)

Although the library provides some utility functions related to other libraries like django, it does not install any dependencies automatically.
This means, you can install the library even if you do not use these libraries, but keep in mind that in this case you cannot use the
functions that depend on them.

You can also chose to install the dependencies alongside the library, including the library in the requirements in the form::

    cardo-python-utils[django]

Tests
-----
The library has a high coverage by tests. If you want to see tests in action:

1. Inside venv, run  ``pip install -r tests/requirements.txt``

2. Run tests via ``pytest`` command
