Metadata-Version: 2.3
Name: devopstest-aiexternal-python-library
Version: 1.0.0
Summary: devopstest-aiexternal-python-library
Requires-Python: >=3.11
Project-URL: homepage, https://github.com/ch-robinson-internal/devopstest-aiexternal-python-library
Project-URL: repository, https://github.com/ch-robinson-internal/devopstest-aiexternal-python-library
Description-Content-Type: text/markdown

# devopstest-aiexternal-python-library

[![Build Status](https://dev.azure.com/CHR-IT/Navisphere/_apis/build/status/devopstest-aiexternal-python-library?repoName=ch-robinson-internal%2Fdevopstest-aiexternal-python-library&branchName=main&label=Azure%20Pipeline%20-%20main%20branch)](https://dev.azure.com/CHR-IT/Navisphere/_build/latest/devopstest-aiexternal-python-library?repoName=ch-robinson-internal%2Fdevopstest-aiexternal-python-library&branchName=main)

devopstest-aiexternal-python-library

## Development

To develop the package locally, follow these steps:

### Prerequisites

* Python (at least 3.11)
* [uv](https://docs.astral.sh/uv/getting-started/installation/) for dependency and package management

### Running locally

* Navigate to the project directory:

    ```bash
    cd devopstest-aiexternal-python-library
    ```

* Run the following uv command to create a virtual environment and install the required packages.
    ```bash
    uv sync
    ```

* Ensure that your Python IDE is configured to use the newly created virtual environment.


* Install pre-commit hooks to ensure code quality and style:

    ```bash
    pre-commit install
    ```

    These checks are also run by CI. You can review the list of checks in the .pre-commit-config.yaml file to understand what each hook does.

### Testing

* To run unit tests, use the following command:

    ```bash
    uv run pytest
    ```
