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 installation process by shipping pyTransition as a wheel file #40

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

davidmurray
Copy link

@davidmurray davidmurray commented Jul 12, 2024

See commit message below for details

The wheel file works for any os and any version of Python 3. See wheel file naming convention here: https://peps.python.org/pep-0427/#file-name-convention

@davidmurray davidmurray changed the title Simplify installation instructions by shipping pyTransition as a wheel file Simplify installation process by shipping pyTransition as a wheel file Jul 12, 2024
…allation process in QGIS

Fixes chairemobilite#22. The wheel was packaged by simply running 'pip wheel .' in the pyTransition main folder. The wheel file for the 'requests' library is not included because this library comes with QGIS by default.
Copy link
Contributor

@tahini tahini left a comment

Choose a reason for hiding this comment

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

This is a very good idea! But it raises quite a few questions

  1. Running pip wheel . in the pyTransition directory generates 7 .whl file. You include one here, the commit message mentions we should not include requests. What about the other 5?
$ ls *.whl
certifi-2024.7.4-py3-none-any.whl
charset_normalizer-3.3.2-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
idna-3.7-py3-none-any.whl
pyTransition-0.1.2-py3-none-any.whl
requests-2.32.3-py3-none-any.whl
requests_mock-1.12.1-py2.py3-none-any.whl
urllib3-2.2.2-py3-none-any.whl
  1. I don't think we want to include the .whl file in the repo. We should have the documentation to generate it for those interested in running from the source code. But otherwise, it should be generated when we release a new version of the package, from the latest tested pyTransition version. @greenscientist any advice on the release of a sister library like this?

  2. The .whl file is correctly added to the plugin's deployment file, that's excellent!

There's no changes really asked at this time, just some questions to be answered

@davidmurray
Copy link
Author

@tahini

  1. I think those ship with QGIS by default, that's why I didn't include these ones. To check, open the QGIS console and run "import pip; pip.main(['list'])"
  2. Yes, great idea. I'm not sure how the release process works but this should be automated in that process.

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