Depots.fetch_two_char_tops_codes

Depots.fetch_two_char_tops_codes(update=False, pickle_it=False, data_dir=None, verbose=False)[source]

Fetch two-character TOPS codes from local backup.

Parameters

  • update (bool) – whether to check on update and proceed to update the package data, defaults to False

  • pickle_it (bool) – whether to replace the current package data with newly collected data, defaults to False

  • data_dir (str or None) – name of package data folder, defaults to None

  • verbose (bool) – whether to print relevant information in console as the function runs, defaults to False

Returns

data of two-character TOPS codes and date of when the data was last updated

Return type

dict

Example:

>>> from pyrcs.other_assets import Depots

>>> depots = Depots()

>>> # tct_codes = depots.fetch_two_char_tops_codes(update=True, verbose=True)
>>> tct_codes = depots.fetch_two_char_tops_codes()

>>> type(tct_codes)
dict
>>> list(tct_codes.keys())
['Two character TOPS codes', 'Last updated date']

>>> print(tct_codes['Two character TOPS codes'].head())
  Code click to sort  ...                Notes
0                 AB  ...          Closed 1987
1                 AB  ...
2                 AC  ...  Became WH from 1994
3                 AC  ...
4                 AD  ...
[5 rows x 5 columns]