Metadata-Version: 2.1
Name: jara-utils
Version: 0.1.1
Summary: A package with basic stuff.
Home-page: https://github.com/senciucserban/jara-utils
Author: Serban Senciuc
Author-email: senciuc.serban@gmail.com
Requires-Python: >=3.9,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Provides-Extra: test
Requires-Dist: Faker (>=4.14.0,<5.0.0); extra == "test"
Requires-Dist: flake8 (>=3.8.4,<4.0.0); extra == "test"
Requires-Dist: flake8-quotes (>=3.2.0,<4.0.0); extra == "test"
Requires-Dist: mypy (>=0.790,<0.791); extra == "test"
Requires-Dist: pytest (>=6.1.2,<7.0.0); extra == "test"
Requires-Dist: pytest-asyncio (>=0.14.0,<0.15.0); extra == "test"
Requires-Dist: pytest-cov (>=2.10.1,<3.0.0); extra == "test"
Requires-Dist: pytest-sugar (>=0.9.4,<0.10.0); extra == "test"
Requires-Dist: pytz (>=2020.1,<2021.0)
Project-URL: Repository, https://github.com/senciucserban/jara-utils
Description-Content-Type: text/x-rst

=================
Jara core package
=================

    Jara means bear in `Sesotho`_.

.. image:: https://img.shields.io/badge/python-3.7.x-blue.svg
    :alt: Python 3.7.x

.. image:: https://img.shields.io/badge/code_style-flake8-brightgreen.svg
    :alt: Flake8

.. image:: https://img.shields.io/badge/dependency_manager-poetry-blueviolet.svg
    :alt: Poetry

Why?
~~~~
Sometimes I start a new project and I need to implement again same methods and after create tests for each method. This package will provide common methods like ``str_2_bool`` or other methods check ``README.rst`` for all methods available.

How to contribute to the package?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Clone project locally and then:
    * Install all dependencies including the test ones: ``poetry install -E test``;
    * Do changes in the project;
    * Create unittests (please make sure  you will keep coverage to 100%);
    * Run all sanity commands (pytest, flake8, mypy)

Note: Run commands using poetry: ``poetry run pytest``;

What you will find in this package?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Basically will contain utils methods to avoid write them in all projects.

Some examples:
    * decorator to benchmark methods;
    * methods to handle environment variables;
    * some utils methods such as: ``snake_2_camel``, ``str_2_bool``.


.. _Sesotho: https://en.wikipedia.org/wiki/Sotho_language

