core-redis
===============================================================================

This project/library contains common elements related
to Redis integration...

===============================================================================

.. image:: https://img.shields.io/pypi/pyversions/core-redis.svg
    :target: https://pypi.org/project/core-redis/
    :alt: Python Versions

.. image:: https://img.shields.io/badge/license-MIT-blue.svg
    :target: https://gitlab.com/bytecode-solutions/core/core-redis/-/blob/main/LICENSE
    :alt: License

.. image:: https://gitlab.com/bytecode-solutions/core/core-redis/badges/release/pipeline.svg
    :target: https://gitlab.com/bytecode-solutions/core/core-redis/-/pipelines
    :alt: Pipeline Status

.. image:: https://readthedocs.org/projects/core-redis/badge/?version=latest
    :target: https://readthedocs.org/projects/core-redis/
    :alt: Docs Status

.. image:: https://img.shields.io/badge/security-bandit-yellow.svg
    :target: https://github.com/PyCQA/bandit
    :alt: Security

|


Installation
===============================================================================

Install from PyPI using pip:

.. code-block:: bash

    pip install core-redis
    uv pip install core-redis  # Or using UV...


Features
===============================================================================

- "..."



Quick Start
===============================================================================

Installation
-------------------------------------------------------------------------------

Install the package:

.. code-block:: bash

    pip install core-redis
    uv pip install core-redis   # Or using UV...
    pip install -e ".[dev]"     # For development...


Setting Up Environment
-------------------------------------------------------------------------------

1. Install required libraries:

.. code-block:: bash

    pip install --upgrade pip
    pip install virtualenv

2. Create Python virtual environment:

.. code-block:: bash

    virtualenv --python=python3.12 .venv

3. Activate the virtual environment:

.. code-block:: bash

    source .venv/bin/activate

Install packages
-------------------------------------------------------------------------------

.. code-block:: bash

    pip install .
    pip install -e ".[dev]"

Check tests and coverage
-------------------------------------------------------------------------------

.. code-block:: shell

    python manager.py run-tests
    python manager.py run-tests --test-type integration
    python manager.py run-coverage

    # For functional tests...
    python manager.py run-tests --test-type functional --pattern "*.py"


Contributing
===============================================================================

Contributions are welcome! Please:

1. Fork the repository
2. Create a feature branch
3. Write tests for new functionality
4. Ensure all tests pass: ``pytest -n auto``
5. Run linting: ``pylint core_redis``
6. Run security checks: ``bandit -r core_redis``
7. Submit a pull request


License
===============================================================================

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


Links
===============================================================================

* **Documentation:** https://core-redis.readthedocs.io/en/latest/
* **Repository:** https://gitlab.com/bytecode-solutions/core/core-redis
* **Issues:** https://gitlab.com/bytecode-solutions/core/core-redis/-/issues
* **Changelog:** https://gitlab.com/bytecode-solutions/core/core-redis/-/blob/master/CHANGELOG.md
* **PyPI:** https://pypi.org/project/core-redis/


Support
===============================================================================

For questions or support, please open an issue on GitLab or contact the maintainers.


Authors
===============================================================================

* **Alejandro Cora González** - *Initial work* - alek.cora.glez@gmail.com
