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

Define optional dependencies as extras #126

Open
3 tasks
unflxw opened this issue Sep 5, 2023 · 1 comment
Open
3 tasks

Define optional dependencies as extras #126

unflxw opened this issue Sep 5, 2023 · 1 comment

Comments

@unflxw
Copy link
Contributor

unflxw commented Sep 5, 2023

Currently, we rely on our installer detecting the presence of certain dependencies and installing the right opentelemetry-instrumentation-something package for them, or on users manually installing those dependencies as described on the docs.

We could use "package extras", which are optional dependencies that are specified at install time, to improve the experience somewhat. Instead of installing appsignal and opentelemetry-instrumentation-django, users could install appsignal[django], which would install both. The installer could also do this. (More than one can be installed -- e.g. appsignal[django,celery])

This also allows us to specify version bounds for the OpenTelemetry instrumentation package, ensuring that our users aren't upgrading their AppSignal package, but using an old (potentially unsupported or missing features) version of the instrumentations.

  • Define optional dependencies as extras
  • Change the docs to specify installation of extras instead of OTel packages
  • Change the installer to write extras instead of OTel packages to requirements.txt
@backlog-helper
Copy link

backlog-helper bot commented Sep 5, 2023

✔️ All good!

New issue guide | Backlog management | Rules | Feedback

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant