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

Simplify project install requirements #342

Open
JacobCallahan opened this issue Jan 15, 2025 · 1 comment
Open

Simplify project install requirements #342

JacobCallahan opened this issue Jan 15, 2025 · 1 comment
Assignees
Labels
0.7 dependencies An update to one or more dependencies

Comments

@JacobCallahan
Copy link
Member

Base Requirements

We currently define Broker's base requirements as the following.

dependencies = [
    "awxkit",
    "click",
    "dynaconf<4.0.0",
    "logzero",
    "packaging",
    "rich",
    "rich_click",
    "ruamel.yaml",
    "setuptools",
    "ssh2-python312",
]

In this list, we should immediately remove "awxkit" and "ssh2-python312" (more on that below).
However, we may also be able to remove setuptools from the base requirements, but we'd need to test that.
The rest of the requirements are pretty core to Broker's functionality.
All of Broker uses dynaconf, logzero, and ruamel.
The cli needs click, packaging, rich, and rich_click.

We do currently pin dynaconf to less than 4.0 due to an issue we had in the past, one that I can't immediately recall. However, we can also evaluate if a newer version of it has resolved the problem.

AnsibleTower and awxkit

Up until now, the vast majority of Broker installations have heavily used the AnsibleTower provider. Because of this, we have kept awxkit as a base dependency.
Now that we have other teams using (and considering) Broker, we shouldn't force awxkit as a base dependency.
Instead, we will make this an optional dependency named "aap", "ansible", "ansibletower", or something similar.

SSH Backends

As of the time I'm writing this, the author of ssh2-python has returned and published new versions of the project for up to Python 3.13! This means we can drop the dependency on my fork and keep the single dependency for ssh2-python instead.
With this, I'm also going to not include a ssh backend library in the base requirements. Users will need to select one with the optional dependencies much like they do for alternate backends.

@JacobCallahan JacobCallahan added 0.7 dependencies An update to one or more dependencies labels Jan 15, 2025
@JacobCallahan JacobCallahan self-assigned this Jan 15, 2025
@ogajduse
Copy link
Member

I think your proposal makes sense to me. 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
0.7 dependencies An update to one or more dependencies
Projects
None yet
Development

No branches or pull requests

2 participants