Metadata-Version: 2.1
Name: hivecode
Version: 0.0.0.8.22
Summary: Hivecode is a series of libraries desgined to make programming less of an artisan task and more of an engineering task. It includes functions, decorators and multiple classes desgiined to make the implementation of development and analytical proyects more oriented to desigin and architecture and less of an implementation hell.
Author: Juan Manuel Mejía Botero
Author-email: Juan Manuel Mejía Botero <juanmam941025@gmail.com>, Sebastian López Valencia <sebaslv12@hotmail.com>
Project-URL: Homepage, https://github.com/Juanmam/hivecode
Project-URL: Documentation, https://hivecode.readthedocs.io/en/latest/
Platform: unix
Platform: linux
Platform: osx
Platform: cygwin
Platform: win32
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.8.0
Description-Content-Type: text/x-rst
Requires-Dist: paramiko (==2.11.0)
Requires-Dist: scp (==0.14.4)
Requires-Dist: scikit-learn (==1.1.3)
Requires-Dist: azure-cosmos (==4.3.0)
Requires-Dist: openpyxl (==3.0.10)
Requires-Dist: tqdm (==4.65.0)
Requires-Dist: scipy (==1.10.0)
Requires-Dist: matplotlib (==3.7.2)
Requires-Dist: numpy (==1.25.0)
Requires-Dist: pandas (==2.0.3)
Requires-Dist: seaborn (==0.11.1)
Requires-Dist: category-encoders (==2.6.1)
Requires-Dist: polars (==0.18.7)
Provides-Extra: dev
Requires-Dist: build ; extra == 'dev'
Requires-Dist: twine ; extra == 'dev'
Requires-Dist: Sphinx ; extra == 'dev'
Provides-Extra: testing
Requires-Dist: pytest (>=6.0) ; extra == 'testing'
Requires-Dist: pytest-cov (>=2.0) ; extra == 'testing'
Requires-Dist: mypy (>=0.910) ; extra == 'testing'
Requires-Dist: flake8 (>=3.9) ; extra == 'testing'
Requires-Dist: tox (>=3.24) ; extra == 'testing'

.. |PyPI version Hivecode| image:: https://img.shields.io/pypi/v/hivecode.svg
   :target: https://pypi.org/project/hivecode/

.. |Documentation Status| image:: https://readthedocs.org/projects/hivecode/badge/?version=latest
   :target: http://hivecode.readthedocs.io/?badge=latest

.. |MIT license| image:: https://img.shields.io/badge/License-MIT-blue.svg
   :target: https://lbesson.mit-license.org/

.. |PyPI license| image:: https://img.shields.io/pypi/l/hivecode.svg
   :target: https://pypi.org/project/hivecode/

Hivecode
========
|PyPI version Hivecode| |Documentation Status| |MIT license|

Hivecode is a Python library designed as a toolkit for data engineering and data science. The library includes a collection of useful functions and tools for reading, mounting, and storing data in Azure DataBricks. Hivecode also includes patterns, decorators, and analytics tools to help make your data processing workflow more efficient and streamlined. With Hivecode, you can simplify your data engineering and analysis tasks, freeing up your time to focus on more strategic work. Whether you're a data engineer, data analyst, or data scientist, Hivecode has something to offer.

Packages
========
- Hivecore: A set of many vanilla python tools.
- Hiveadb: A set of tools to work in Azure Databricks.
- Hivesignal: A set of tools for signal analysis.

Installation
============
To install the library, you will need pip.

|

.. code-block::

    pip install hivecode

|

.. note::
     Hivecode is constantly changing as new versions try to make it a more stable library. It is highly recommended to specify the version you want to import.

|

Requirements
------------
Hivecode requires Python 3.8.0+ to run.

Development
===========
Requirements
------------
Build is used to build the packages that will be deployed into pypi.

|

.. code-block::

    pip install build

|

Twine is used to deploy packages to pypi.

|

.. code-block::

    pip install twine

|
    
Sphinx is used to build the documentation.

|

.. code-block::

    pip install Sphinx

|

Develop
-------
You can build the project by running the following console command.

|

.. code-block::

    python -m build

|

You can then use twine to upload the newest version to Pypi.

|

.. code-block::

    py -m twine upload --skip-existing --repository pypi dist/* -u {User} -p {password}

|

I personally recommend to cascade both commands using a pipe, like this.

|

.. code-block::

    python -m build | py -m twine upload --skip-existing --repository pypi dist/* -u {User} -p {password}

|

When working with documentations, you will need to run it like this.

|

.. code-block::

    .\doc\make.bat html

|
