Added Exception for not ready methods

pyrmv/__init__.py

@@ -21,7 +21,7 @@ trip = pyrmv.trip_find(access_id, origin_id=origin.id, dest_id=destination.id)
 """
 
 __name__ = "pyrmv"
-__version__ = "0.2.7"
+__version__ = "0.2.8"
 __license__ = "MIT License"
 __author__ = "Profitroll"
 

pyrmv/errors/not_ready.py

@@ -0,0 +1,9 @@
+class NotReadyYetError(Exception):
+    """
+    This method is not finished yet.
+    """
+    def __init__(self):
+        super().__init__(self.__doc__)
+
+    def __str__(self):
+        return self.__doc__

pyrmv/methods/__init__.py

@@ -1,3 +1,8 @@
-from .trip_find import trip_find
+from .board_arrival import board_arrival
+from .board_departure import board_departure
+from .him_search import him_search
+from .journey_detail import journey_detail
 from .stop_by_coords import stop_by_coords
-from .stop_by_name import stop_by_name
+from .stop_by_name import stop_by_name
+from .trip_find import trip_find
+from .trip_recon import trip_recon

pyrmv/methods/board_arrival.py

@@ -0,0 +1,5 @@
+from pyrmv.errors.not_ready import NotReadyYetError
+
+
+def board_arrival():
+    raise NotReadyYetError()

pyrmv/methods/board_departure.py

@@ -0,0 +1,5 @@
+from pyrmv.errors.not_ready import NotReadyYetError
+
+
+def board_departure():
+    raise NotReadyYetError()

pyrmv/methods/journey_detail.py

@@ -0,0 +1,5 @@
+from pyrmv.errors.not_ready import NotReadyYetError
+
+
+def journey_detail():
+    raise NotReadyYetError()

pyrmv/methods/trip_recon.py

@@ -0,0 +1,5 @@
+from pyrmv.errors.not_ready import NotReadyYetError
+
+
+def trip_recon():
+    raise NotReadyYetError()

setup.py

@@ -2,7 +2,7 @@ from setuptools import setup
 
 setup(
     name="pyrmv",
-    version="0.2.7",
+    version="0.2.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# Usage\n\n```py\nimport pyrmv\n\n# Set API key\naccess_id = \"Something\"\n\n# Get origin's and destination's location\norigin = pyrmv.stop_by_name(access_id, \"Frankfurt Hauptbahnhof\", max_number=3)[0]\ndestination = pyrmv.stop_by_coords(access_id, 50.099613, 8.685449, max_number=3)[0]\n\n# Find a trip by locations got\ntrip = pyrmv.trip_find(access_id, origin_id=origin.id, dest_id=destination.id)\n```\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## General\n- [ ] Docs in Wiki\n\n## Raw methods\n- [x] arrivalBoard (board_arrival)  \n- [x] departureBoard (board_departure)  \n- [x] himsearch (him_search)  \n- [x] journeyDetail (journey_detail)\n- [x] location.nearbystops (stop_by_coords)  \n- [x] location.name (stop_by_name)  \n- [x] trip (trip_find)  \n- [x] recon (trip_recon)\n\n## Normal methods\n- [ ] arrivalBoard (board_arrival)  \n- [ ] departureBoard (board_departure)  \n- [ ] himsearch (him_search)  \n- [ ] journeyDetail (journey_detail)\n- [x] location.nearbystops (stop_by_coords)  \n- [x] location.name (stop_by_name)  \n- [x] trip (trip_find)  \n- [ ] recon (trip_recon)",