argusquery-api 0.0.1

A Python API for executing backend admin workflows for ArgusQuery

ArgusQuery API

An open source API for conducting LLM search via requests to the ArgusQuery backend

Table of Contents

1. Installation
2. Usage
3. Dependencies
4. Development
5. License

Installation

PyPi

Coming soon...

Source

Be sure to have poetry installed for build and dependency management. It is highly recommended to install this library using pipx. See documentation for installation instructions here.

Note: Do not use pipx to install libraries other than poetry unless you know what you are doing.

pipx install poetry
poetry build
pip install dist/argusquery_api*.whl

Usage

This section of the README is under construction. In the meantime, refer to the Jupyter Notebooks located under /examples

Dependencies

Python Version

>= 3.10 required : see below for a list of critical versioned features included in this library

• 3.10 : union type hints using pipe | character
• 3.7 : dataclasses
• 3.5 : type hints

Core Dependencies

pydantic : Docs | GitHub | PyPI

requests : Docs | GitHub | PyPI

Testing Dependencies

coverage : Docs | GitHub | PyPI

genbadge : Docs | GitHub | PyPI

pytest : Docs | GitHub | PyPI

Development

The following command installs all core package dependencies and the project library:

poetry install

To avoid installing the project library, use the --no-root flag, for example:

poetry install --no-root

To install testing dependencies, supply --with test to the install command, for example:

poetry install --with test

This is typically all that is required to continue to testing. Otherwise, see the poetry documentation for a full list of commands here.

After installing testing dependencies, check out the Makefile for some handy make invocations.

OS Compatibility

In the CircleCI pipeline, testing occurs on an Ubuntu 22.04 amd64 Linux machine, running the cimg/python:3.10.14 image. See image specifics at CircleCI docs and Docker Hub.

License

This project is distributed under the terms of the MIT license.