ACE Core Centralize
===================

    *A Python Package for ACE to interact with Centralize.*

**ACE Core Centralize** is a package used within ACE Script Centralize to simplify the integration with Centralize. It enables developers to quickly build and automate scripts using a set of base rules. The package caches centralization codes for fast and reliable access, and provides the classes, functions, and utilities needed to create robust ACE scripts.

It is designed to be modular and extensible, allowing developers to easily add new features and functionality as needed.

------------

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

Create a virtual environment and activate it:

.. code-block:: bash

    python -m venv ace-env
    source ace-env/bin/activate  # On Windows use: ace-env\Scripts\activate

You can install **ACE** using one of the following methods:

1. From Azure DevOps
^^^^^^^^^^^^^^^^^^^^

.. code-block:: bash

    pip install https://EquisoftOrganization@dev.azure.com/EquisoftOrganization/ace/_git/ace-core-centralize/build/ace_core_centralize-<version>-py3-none-any.whl

*Replace* ``<version>`` *with the desired version number.*

2. From a local wheel file
^^^^^^^^^^^^^^^^^^^^^^^^^^

Clone the repository:

.. code-block:: bash

    git clone https://EquisoftOrganization@dev.azure.com/EquisoftOrganization/ace/_git/ace-core-centralize

Install a specific version:

.. code-block:: bash

    pip install /path/to/ace-core-centralize/build/ace_core_centralize-<version>-py3-none-any.whl

*Replace* ``<version>`` *with the desired version number.*

3. Editable install (for development)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. code-block:: bash

    git clone https://EquisoftOrganization@dev.azure.com/EquisoftOrganization/ace/_git/ace-core-centralize
    cd ace-core-centralize
    pip install -e .

------------

Configuration
-------------

Environment variables or config files:

.. code-block:: bash

    export ACE_API_URL="https://api.example.com"
    export ACE_API_KEY="YOUR_API_KEY"

For the full list of environment variables, see the `configuration documentation <https://equisoft.atlassian.net/wiki/x/fwnBB>`_.

------------

Usage
-----

Basic usage example:

.. code-block:: python

    from ace.centralize.api_client import APIClient

    client = APIClient(base_url="https://api.example.com", api_key="YOUR_API_KEY")
    tile = client.get_dashboard_tile("12345")
    print(tile)


Testing
-------

Run the test suite:

.. code-block:: bash

    pytest

------------

Contributing
------------

1. Clone the repo and create a feature branch
2. Install dev dependencies:

   .. code-block:: bash

       pip install -e .[dev]

3. Write tests and documentation
4. Open a pull request

------------

License
-------

*Add license information here.*

------------

Useful Links
------------
- `Using codes in Cache - Ace Centralize Dev: https://equisoft.atlassian.net/wiki/spaces/EQUISOFTACE/pages/435815787/Using+codes+in+Cache+-+Ace+Centralize+Dev`