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

Allow running as module #73

Merged
merged 3 commits into from
Mar 26, 2024

Conversation

rkent
Copy link
Contributor

@rkent rkent commented Mar 22, 2024

When developing rosdoc2, it can be convenient to run it as a module directly rather than having to install each time, or trying to make an editable install work. This minor change should allow it.

@rkent rkent requested review from audrow and tfoote as code owners March 22, 2024 21:13
Copy link
Member

@tfoote tfoote left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this have significant benefits over using --editable from pip install?

@rkent
Copy link
Contributor Author

rkent commented Mar 22, 2024

Maybe I am doing wrong, but whenever I use --editable it demands that I be using a venv, which I don't typically do. That adds extra overhead to running things.

Other than that, the main advantage is that you don't have to modify your rosdoc2 install.

It's not a big deal, really with the testing infrastructure I am proposing the vast majority of development takes place there. But if I am trying to fix an issue that exists in a package, and I don't want to add that issue to a test case, this could be useful.

Copy link
Member

@tfoote tfoote left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess I always do venv based development these days as I jump environments all the time and often need to have whole chains of dependencies different. If this enables working on this without it though. The change is small enough in unobtrusive enough that it seems fine to me to support that approach too.

@tfoote tfoote merged commit ce98706 into ros-infrastructure:main Mar 26, 2024
2 checks passed
@rkent rkent deleted the allow-running-as-module branch March 26, 2024 18:32
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