ENH: Make timezonefinder an optional dependency #315
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull request type
Please check the type of change your PR introduces:
Pull request checklist
Please check if your PR fulfills the following requirements, depending on the type of PR:
Code base additions (for bug fixes / features):
black rocketpy
) has passed locally and any fixes were madepytest --runslow
) have passed locallyWhat is the current behavior?
timezonefinder
package does not support Python 3.7 anymore. See Significant Dependency Issue: Timezonefinder does not support Python 3.7 #314.timezonefinder
package is rarely used and not required for any major RocketPy functionality. It is currently a required package inspite of this. And to make things worse, it requires a download larger than 40 MB.What is the new behavior?
The
timezonefinder
is made an optional requirement. By default, when installing RocketPy, it will not be installed and thus RocketPy will remain compatible with Python 3.7. The total downloads needed to install RocketPy will be reduced by about 40 MB. If the user desires, he/she can install the optional requirement using:Note, however, that this only works with Python 3.8+.
The only feature that is not supported when
timezonefinder
is not installed is automatic timezone detection based on latitude and longitude when initializing theEnvironmentAnalysis
class. The user needs to specify the timezone to be used for reporting. If the user does not specify it, the following error will be raised:Does this introduce a breaking change?
Other information
This PR should solve the failing GitHub Actions that has been haunting us for a couple of months now.