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

Make the repository pip install-able #31

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

anand-bala
Copy link

This PR makes the repository installable as:

$ pip install git+https://github.com/StanfordASL/stlcg.git@<commit/branch>

or as

$ pip install https://github.com/StanfordASL/stlcg/archive/<commit/branch>.tar.gz

It also adds a pyproject.toml file for project metadata and configuration.

While the current version of the repository is also technically pip install-able, it does so by installing a top-level module named src under which you will find the modules src.stlcg, src.stlviz, src.utils, and src.logger.
This isn't really correct, nor is it ergonomic.

The other option is to copy just the stlcg.py file into your local, but that defeats the purpose of a package manager like pip. 😄

And thanks for your work!

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.

1 participant