Fixed arguments

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.6"
+__version__ = "0.2.7"
 __license__ = "MIT License"
 __author__ = "Profitroll"
 

pyrmv/classes/Gis.py

@@ -1,6 +1,7 @@
 from isodate import parse_duration
 
 class Gis():
+    """Gis object."""    
     
     def __init__(self, ref: str, route: dict):
         

pyrmv/classes/Leg.py

@@ -4,6 +4,7 @@ from pyrmv.classes.Stop import StopTrip
 from isodate import parse_duration
 
 class Leg():
+    """Trip leg object."""    
     
     def __init__(self, data: dict):
 

pyrmv/classes/Message.py

@@ -3,6 +3,7 @@ from datetime import datetime
 from isodate import parse_duration
 
 class Url():
+    """Traffic message channel url object."""    
 
     def __init__(self, data: dict) -> None:
         self.name = data["name"]
@@ -12,6 +13,7 @@ class Url():
         return f"{self.name}: {self.url}"
 
 class Channel():
+    """Traffic message channel object."""    
 
     def __init__(self, data: dict) -> None:
         self.name = data["name"]
@@ -29,6 +31,7 @@ class Channel():
 
 
 class Message():
+    """Traffic message object."""    
 
     def __init__(self, data: dict) -> None:
 

pyrmv/classes/Stop.py

@@ -2,6 +2,7 @@ from datetime import datetime
 
 
 class Stop():
+    """Stop object."""    
     
     def __init__(self, data: dict):
 
@@ -11,6 +12,10 @@ class Stop():
             self.ext_id = data["extId"]
         else:
             self.ext_id = None
+        if "description" in data:
+            self.description = data["description"]
+        else:
+            self.description = None
         self.lon = data["lon"]
         self.lat = data["lat"]
 
@@ -18,6 +23,7 @@ class Stop():
         return f"Stop {self.name} at {self.lon}, {self.lat}"
 
 class StopTrip(Stop):
+    """Trip stop object. It's like a Stop object, but with a date and time."""    
 
     def __init__(self, data: dict):
         

pyrmv/classes/Trip.py

@@ -3,6 +3,7 @@ from pyrmv.classes.Stop import StopTrip
 from isodate import parse_duration
 
 class Trip():
+    """Trip object."""    
     
     def __init__(self, data: dict):
         

pyrmv/enums/filter_mode.py

@@ -2,7 +2,12 @@ from enum import auto
 from .auto_name import AutoName
 
 class FilterMode(AutoName):
-    """Enumeration used to declare filters for nearby searches."""
+    """Enumeration used to declare filters for nearby searches.  
+    
+    * DIST_PERI - Accentuate matches. Matches in the radius are first
+    * EXCL_PERI - Returns matches inside the radius only
+    * SLCT_PERI - Matches in the radius are excluded. Returns matches outside the radius only
+    """
 
     DIST_PERI = auto()
     "Accentuate matches. Matches in the radius are first."

pyrmv/enums/location_type.py

@@ -2,7 +2,22 @@ from enum import auto
 from .auto_name import AutoName
 
 class LocationType(AutoName):
-    """Enumeration used to declare types of location filter."""
+    """Enumeration used to declare types of location filter.  
+    
+    * S - Search for station/stops only
+    * A - Search for addresses only
+    * P - Search for POIs only
+    * AP - Search for addresses and POIs
+    * SA - Search for station/stops and addresses
+    * SE - Search for stations/stops and entrypoints
+    * SP - Search for stations/stops and POIs
+    * ALL - Search in all existing location pools
+    * SPE - Search for stations/stops, POIs and entrypoints
+
+    Note that not all location types may be available for a certain methods.
+    Make sure that selected type is supported by method by looking up 
+    its acceptable types in argument description.
+    """
 
     S = auto()
     "Search for station/stops only"

pyrmv/enums/selection_mode.py

@@ -2,7 +2,11 @@ from enum import auto
 from .auto_name import AutoName
 
 class SelectionMode(AutoName):
-    """Enumeration used to declare location selection modes."""
+    """Enumeration used to declare location selection modes.
+    
+    * SLCT_A - Selectable
+    * SLCT_N - Not selectable
+    """
 
     SLCT_A = auto()
     "Selectable"

pyrmv/methods/stop_by_coords.py

@@ -45,7 +45,7 @@ def stop_by_coords(
     if selection_mode == None:
         selection_mode = None
     else:
-        selection_mode = (selection_mode.code).upper()
+        selection_mode = selection_mode.code
 
     stops = []
     stops_raw = raw_stop_by_coords(
@@ -55,7 +55,7 @@ def stop_by_coords(
         lang=lang.code,
         radius=radius,
         maxNo=max_number,
-        stopType=(stop_type.code).upper(),
+        stopType=stop_type.code,
         locationSelectionMode=selection_mode
     )
 

pyrmv/methods/stop_by_name.py

@@ -55,7 +55,7 @@ def stop_by_name(
     if selection_mode == None:
         selection_mode = None
     else:
-        selection_mode = (selection_mode.code).upper()
+        selection_mode = selection_mode.code
 
     stops = []
     stops_raw = raw_stop_by_name(
@@ -63,14 +63,14 @@ def stop_by_name(
         inputString=query,
         lang=lang.code,
         maxNo=max_number,
-        stopType=(stop_type.code).upper(),
+        stopType=stop_type.code,
         locationSelectionMode=selection_mode,
         coordLat=coord_lat,
         coordLong=coord_lon,
         radius=radius,
         refineId=refine_id,
         stations=stations,
-        filterMode=(filter_mode.code).upper()
+        filterMode=filter_mode.code
     )
 
     find_exception(stops_raw)

pyrmv/raw/stop_by_coords.py

@@ -54,7 +54,13 @@ def stop_by_coords(accessId: str,
     payload = {}
 
     for var, val in locals().items():
-        if str(var) not in ["json", "headers", "payload", "raw_response"]:
+        if str(var) == "stopType":
+            if val != None:
+                payload["type"] = val.upper()
+        elif str(var) == "locationSelectionMode":
+            if val != None:
+                payload["locationSelectionMode"] = val.upper()
+        elif str(var) not in ["json", "headers", "payload", "raw_response"]:
             if val != None:
                 payload[str(var)] = val
 

pyrmv/raw/stop_by_name.py

@@ -68,7 +68,13 @@ def stop_by_name(accessId: str,
         if str(var) == "inputString":
             if val != None:
                 payload["input"] = val
-        elif str(var) not in ["json", "headers", "payload", "raw_response"]:
+        elif str(var) == "stopType":
+            if val != None:
+                payload["type"] = val.upper()
+        elif str(var) == "filterMode":
+            if val != None:
+                payload["filterMode"] = val.upper()
+        elif str(var) not in ["json", "headers", "payload", "raw_response", "stopType"]:
             if val != None:
                 payload[str(var)] = val
 

setup.py

@@ -2,7 +2,7 @@ from setuptools import setup
 
 setup(
     name="pyrmv",
-    version="0.2.6",
+    version="0.2.7",
     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)",