Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Split-off the API client resources in an isolated sub-package #198

Merged
merged 3 commits into from
Nov 20, 2024

Conversation

airwoodix
Copy link
Collaborator

Summary

This patch moves most of the resources associated to the Qiskit-agnostic API client to an isolated sub-package at qiskit_aqt_provider.api_client. The isolation is enforced by the newly configured tach setup.

The realize the isolation, the User-Agent string now declares a different name for the client (i.e. not mentioning qiskit-aqt-provider anymore). The remaining information stays the same.

Follow-up work will include moving all Qiskit-agnostic resources to the qiskit_aqt_provider.api_client package as well as defining a clean public interface for that package (that is, enable tach's strict mode for qiskit_aqt_provider.api_client). This sub-package could then be published as an independent package.

Details and comments

The tach setup also includes running tach check-external. This unfortunately has a number of issues:

  • only "main" project dependencies are scanned, so we need to ignore the tests
  • extra dependencies are considered unused because none of the extras is relevant for the main code-base. This is in particular the case for the test extra introduced in Add test dependency group #183. Those dependencies need to be manually excluded in the tach configuration.
  • running tach check-external as a pre-commit hook breaks because the package metadata is not available for tach to understand that python_dotenv is the distribution name for the dotenv package. This will be fixed upstream.

@airwoodix airwoodix self-assigned this Nov 20, 2024
@airwoodix airwoodix marked this pull request as ready for review November 20, 2024 11:22
tach.toml Outdated Show resolved Hide resolved
Co-authored-by: Wilfried Huss <84843123+wilfried-huss@users.noreply.github.com>
@airwoodix airwoodix merged commit 96f77a3 into master Nov 20, 2024
15 checks passed
@airwoodix airwoodix deleted the isolate-api-client branch November 20, 2024 12:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants