From a9801c5ac34161e4a80282e807087b1fd13ee177 Mon Sep 17 00:00:00 2001 From: Profitroll <47523801+profitrollgame@users.noreply.github.com> Date: Fri, 23 Sep 2022 11:16:59 +0200 Subject: [PATCH 1/2] Updated version to 0.1.8 --- pyrmv/__init__.py | 2 +- setup.py | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/pyrmv/__init__.py b/pyrmv/__init__.py index cba6747..7971464 100644 --- a/pyrmv/__init__.py +++ b/pyrmv/__init__.py @@ -31,7 +31,7 @@ really sophisticated. However I'm not sure whether RMV supports that many HAFAS """ __name__ = "pyrmv" -__version__ = "0.1.7" +__version__ = "0.1.8" __license__ = "MIT License" __author__ = "Profitroll" diff --git a/setup.py b/setup.py index 7cef92f..b84a89b 100644 --- a/setup.py +++ b/setup.py @@ -2,10 +2,10 @@ from setuptools import setup setup( name="pyrmv", - version="0.1.7", + version="0.1.8", author="Profitroll", description="Small module that makes your journey with RMV REST API somehow easier.", - long_description="# PythonRMV\n\nSmall module that makes your journey with RMV REST API somehow easier. Based fully on official RMV API reference and HAFAS documentation.\n\n# Frequently Asked Questions\n\n- [Why are there raw versions and formatted ones?](#why-are-there-raw-versions-and-formatted-ones)\n- [Some methods work slightly different](#some-methods-work-slightly-different)\n- [Documentation is not perfectly clear](#documentation-is-not-perfectly-clear)\n\n## Why are there raw versions and formatted ones?\n\nFor the purposes of my projects I don't really need all the stuff RMV gives (even though it's not much).\nI only need some specific things. However I do understand that in some cases other users may find\nthose methods quite useful so I implemented them as well.\n\n\n## Some methods work slightly different\n\nCan be. Not all function arguments written may work perfectly because I simply did not test each and\nevery request. Some of arguments may be irrelevant in my use-case and the others are used quite rare at all.\nJust [make an issue](https://git.end-play.xyz/profitroll/PythonRMV/issues/new) and I'll implement it correct when I'll have some free time.\n\n## Documentation is not perfectly clear\n\nOf course docs cannot be perfect as a python docstring, especially if sometimes I don't\nknow how things should correctly work. That's why you get HAFAS API docs in addition to your\nRMV API key. Just use my functions together with those docs, if you want to build something\nreally sophisticated. However I'm not sure whether RMV supports that many HAFAS features publicly.\n\n# To-Do\n- [ ] arrivalBoard (boardArrival) \n- [ ] departureBoard (boardArrival) \n- [x] himsearch (himSearch) \n- [ ] journeyDetail \n- [x] location.nearbystops (stopByCoords) \n- [x] location.name (stopByName) \n- [ ] recon \n- [x] trip (findRoute)", + long_description="Small module that makes your journey with RMV REST API somehow easier. Based fully on official RMV API reference and HAFAS documentation.\n\n# Frequently Asked Questions\n\n- [Why are there raw versions and formatted ones?](#why-are-there-raw-versions-and-formatted-ones)\n- [Some methods work slightly different](#some-methods-work-slightly-different)\n- [Documentation is not perfectly clear](#documentation-is-not-perfectly-clear)\n\n## Why are there raw versions and formatted ones?\n\nFor the purposes of my projects I don't really need all the stuff RMV gives (even though it's not much).\nI only need some specific things. However I do understand that in some cases other users may find\nthose methods quite useful so I implemented them as well.\n\n\n## Some methods work slightly different\n\nCan be. Not all function arguments written may work perfectly because I simply did not test each and\nevery request. Some of arguments may be irrelevant in my use-case and the others are used quite rare at all.\nJust [make an issue](https://git.end-play.xyz/profitroll/PythonRMV/issues/new) and I'll implement it correct when I'll have some free time.\n\n## Documentation is not perfectly clear\n\nOf course docs cannot be perfect as a python docstring, especially if sometimes I don't\nknow how things should correctly work. That's why you get HAFAS API docs in addition to your\nRMV API key. Just use my functions together with those docs, if you want to build something\nreally sophisticated. However I'm not sure whether RMV supports that many HAFAS features publicly.\n\n# To-Do\n- [ ] arrivalBoard (boardArrival) \n- [ ] departureBoard (boardArrival) \n- [x] himsearch (himSearch) \n- [ ] journeyDetail \n- [x] location.nearbystops (stopByCoords) \n- [x] location.name (stopByName) \n- [ ] recon \n- [x] trip (findRoute)", long_description_content_type="text/markdown", author_email="profitroll@end-play.xyz", url="https://git.end-play.xyz/profitroll/PythonRMV", From a41339b6afe07f0230291783cabe0c7f5a76d3da Mon Sep 17 00:00:00 2001 From: Profitroll <47523801+profitrollgame@users.noreply.github.com> Date: Fri, 23 Sep 2022 11:17:43 +0200 Subject: [PATCH 2/2] Changed types of date/time to Union[str, datetime] --- pyrmv/raw/himSearch.py | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/pyrmv/raw/himSearch.py b/pyrmv/raw/himSearch.py index ecc8232..07cb8e8 100644 --- a/pyrmv/raw/himSearch.py +++ b/pyrmv/raw/himSearch.py @@ -11,10 +11,10 @@ except ImportError: # 2.37. HIM Search (himsearch) def himSearch(accessId: str, json: bool = True, - dateB: str = None, - dateE: str = None, - timeB: str = None, - timeE: str = None, + dateB: Union[str, datetime] = None, + dateE: Union[str, datetime] = None, + timeB: Union[str, datetime] = None, + timeE: Union[str, datetime] = None, weekdays: Dict[str, bool] = None, himIds: Union[str, list] = None, hierarchicalView: bool = False, @@ -52,10 +52,10 @@ def himSearch(accessId: str, ### Args: * accessId (str): _description_ * json (bool, optional): _description_. Defaults to True. - * dateB (str, optional): _description_. Defaults to None. - * dateE (str, optional): _description_. Defaults to None. - * timeB (str, optional): _description_. Defaults to None. - * timeE (str, optional): _description_. Defaults to None. + * dateB (Union[str, datetime], optional): _description_. Defaults to None. + * dateE (Union[str, datetime], optional): _description_. Defaults to None. + * timeB (Union[str, datetime], optional): _description_. Defaults to None. + * timeE (Union[str, datetime], optional): _description_. Defaults to None. * weekdays (Dict[str, bool], optional): _description_. Defaults to None. * himIds (Union[str, list], optional): _description_. Defaults to None. * hierarchicalView (bool, optional): _description_. Defaults to False.