Metadata-Version: 2.4
Name: core-aws
Version: 2.0.0
Summary: This project/library contains common elements related to AWS services...
Author-email: Alejandro Cora González <alek.cora.glez@gmail.com>
Maintainer: Alejandro Cora González
License-Expression: MIT
Project-URL: Homepage, https://gitlab.com/bytecode-solutions/core/core-aws
Project-URL: Repository, https://gitlab.com/bytecode-solutions/core/core-aws
Project-URL: Documentation, https://core-aws.readthedocs.io/en/latest/
Project-URL: Issues, https://gitlab.com/bytecode-solutions/core/core-aws/-/issues
Project-URL: Changelog, https://gitlab.com/bytecode-solutions/core/core-aws/-/blob/master/CHANGELOG.md
Classifier: Intended Audience :: Developers
Classifier: Development Status :: 5 - Production/Stable
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.9
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: aws-encryption-sdk>=4.0.0
Requires-Dist: boto3>=1.35.63
Requires-Dist: botocore>=1.35.63
Requires-Dist: core-ciphers>=1.2.1
Requires-Dist: core-etl>=3.0.0
Requires-Dist: core-mixins>=2.2.0
Requires-Dist: core-tests>=2.0.3
Provides-Extra: all
Requires-Dist: core-cdc>=2.0.1; extra == "all"
Provides-Extra: dev
Requires-Dist: core-dev-tools>=1.0.1; extra == "dev"
Requires-Dist: boto3-stubs>=1.35.0; extra == "dev"
Provides-Extra: core-cdc
Requires-Dist: core-cdc>=2.0.1; extra == "core-cdc"
Provides-Extra: tests
Requires-Dist: core-cdc[mongo]>=2.0.1; extra == "tests"
Requires-Dist: core-cdc[mysql]>=2.0.1; extra == "tests"
Dynamic: license-file

core-aws
===============================================================================

This project/library contains common elements related
to AWS services...

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

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

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

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

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

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

|

Execution Environment
---------------------------------------

Install libraries
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. code-block:: shell

    pip install --upgrade pip
    pip install virtualenv
..

Create the Python Virtual Environment.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. code-block:: shell

    virtualenv --python={{python-version}} .venv
    virtualenv --python=python3.11 .venv
..

Activate the Virtual Environment.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. code-block:: shell

    source .venv/bin/activate
..

Install required libraries
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. code-block:: shell

    pip install .
..

Optional libraries
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. code-block:: shell

    pip install '.[all]'      # For all...
    pip install '.[core-cdc]' # For CDC flows...
    pip install '.[tests]'    # For tests execution...
..

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

    # Having proper AWS credentials...
    python manager.py run-tests --test-type functional --pattern "*.py"
..
