Skip to content

2.0.0 - PEP8 Upgrades

Latest
Compare
Choose a tag to compare
@cyschneck cyschneck released this 05 Jan 23:00

2.0.0 - PEP8, Function Name Deprecations

To adhere to the Pep 8 - Python Style pydar has undergone a large overhaul to user functions names.

The PEP8 update includes changes to:

  • Group imports in alphabetical ordered groups (standard library imports, related third party imports, local specific imports)
  • Function names are lowercase and snakecase
  • Type Hints
  • Backend function names preceded by underscore

Impacted Deprecations:

See the README for additional information about each function

displayImages -> display_all_images
extractFlybyDataImages -> extract_flyby_images
returnAAREADMEOptions -> aareadme_options
readAAREADME -> read_aareadme
returnLBLOptions -> lbl_options
readLBLREADME -> read_lbl_readme
convertFlybyIDToObservationNumber -> id_to_observation
convertObservationNumberToFlybyID -> observation_to_id
retrieveIDSByFeatureName -> ids_from_feature_name
retrieveIDSByLatitudeLongitude -> ids_from_latlon
retrieveIDSByLatitudeLongitudeRange -> ids_from_latlon_range
retrieveIDSByTime -> ids_from_time
retrieveIDSByTimeRange -> ids_from_time_range
retrieveFeaturesFromLatitudeLongitude -> features_from_latlon
retrieveFeaturesFromLatitudeLongitudeRange -> features_from_latlon_range

Additional work

New codecov to aid in expanding testing coverage

Bug fixes and README.md edits

Pytests: Tests for Python 3.11, 3.12, 3.13 against Ubuntu, macOS, Windows