v2.2.0

Warning

constants are changed in this update!

what's new

• special key arrangements for malaysia
• support for termux-location json input

what's fixed

• fixed typing-extensions as an unwritten dependency
  this also fixes a bug in not being able to run surplus in Python 3.12
• fixed italian key arrangements #34

what's changed

• SHAREABLE* constants are now dictionaries, see api docs for more infomation

v2.1.1...v2.2.0

v2.1.1

fix roads not coming first in Italian addresses (#31)

changes

• documentation enhancements
  • remove self in SurplusReverserProtocol conforming signature
  • fix mismatching carets and add info on split_iso3166_2
• alternative line 3 arrangement for IT/Italy in #31

v2.1.0...v2.1.1

v2.1.0

Warning

there are backwards-compatible api changes in this release.

type-to-type location representation conversions and quality of life changes/fixes

changes

• default_geocoder() and default_reverser() functions have been deprecated in favour of the new SurplusDefaultGeocoding class

---

• add reading from stdin when query is "-" in #23
• type to type conversion in #24
• fix local codes not being recognised if split with comma in #29
• more verbose -v/--version information in #21

v2.0.1...v2.1.0

v2.0.1

changes

• Expose surplus.Result in __init__.py by in #28

v2.0.0...v2.0.1

v2.0.0

Warning

this is an api-breaking release. see 'the great api break'.
command-line usage of surplus has not changed.

Important

python 3.11 or later is required due to a bug in earlier versions.
(python/cpython#88089)

complete rewrite and string query support

install this release with pip:

pip install https://github.com/markjoshwel/surplus/releases/download/v2.0.0/surplus-2.0.0-py3-none-any.whl

changes

• surplus has been fully rewritten in #19
• support for string queries

  $ s+ Wisma Atria
  surplus version 2.0.0
  Wisma Atria
  435 Orchard Road
  238877
  Central, Singapore
  

• mypy will now recognise surplus as a typed module
• python 3.11 is now the minimum version

the great api break

what is new

• nominatim keys are now stored in tuple constants
• surplus exception classes are now a thing
• surplus functions now operate using a unified Behaviour object
• surplus functions now return a Result object for safer value retrieval instead of the previous (bool, value) tuple
• dedicated NamedTuple classes for each query type

what has been removed

• surplus.handle_query()

  instead, use .to_lat_long_coord() on your surplus 2.x query object

what has remained

• surplus.surplus(), the function
• surplus.parse_query(), the function

what has changed

• surplus.surplus()

  1. reverser and debug arguments are now under the unified surplus.Behaviour object
  2. function now returns a surplus.Result[str] for safer error handling

• surplus.parse_query()

  1. query and debug arguments are now under the unified surplus.Behaviour object
  2. function now returns a surplus.Result[surplus.Query] for safer error handling

• surplus.Latlong

  attributes lat and long have been renamed to latitude and longitude respectively

• surplus.Localcode

  renamed to surplus.LocalCodeQuery

• Localcode.full_length()

  renamed to LocalCodeQuery.to_full_plus_code(), and returns a surplus.Result[str] for safer error handling

v1.1.3...v2.0.0

v1.1.3

changes

• ci(qc) workflow tweaks by @markjoshwel in #13
• cc: remove woodlands test + brackets by @markjoshwel in #14
• s+: display county before state by @markjoshwel in #15

v1.1.2...v1.1.3

v1.1.2

changes

• do not repeat details by @markjoshwel in #9
• add -v/--version flag by @markjoshwel in #11

v1.1.1...v1.1.2

v1.1.1

changes

fixes and output tweaks

• handle-none-type by @shamsu07 in #5
• 1.1.1 by @markjoshwel in #7

thanks

• @shamsu07 made their first contribution in #5

full changelog: v1.1.0...v1.1.1

v1.1.0

short code and latlong coord support!

• code: s+ alternative shorthand script
• code: handle none/list locations
• code: query by latlong support
• code: support shortcodes with localities
• code: implement more address detail tags from nominatim
• meta: slsa 3 compliance