Updated version to 0.1.9 and changed README

README.md

@@ -20,6 +20,21 @@ If you have everything listed in [requirements](#requirements), then let's begin
 2. `cd PythonRMV`
 3. `python setup.py install`
 
+# Usage
+
+```py
+import pyrmv
+
+accessId = "Something" # Set API key
+
+# Get origin's and destination's location
+origin = pyrmv.raw.stop_by_name(accessid, "Frankfurt Hauptbahnhof", maxNo=3)[0]["StopLocation"]
+destination = pyrmv.raw.stop_by_coords(accessid, 50.099613, 8.685449, maxNo=3)[0]["StopLocation"]
+
+# Find a trip by locations got
+trip = pyrmv.raw.trip_find(accessId, originId=origin["id"], destExtId=destination["id"])
+```
+
 # Frequently Asked Questions
 
 - [Why are there raw versions and formatted ones?](#why-are-there-raw-versions-and-formatted-ones)

pyrmv/__init__.py

@@ -3,38 +3,29 @@
 
 Small module that makes your journey with RMV REST API somehow easier. Based fully on official RMV API reference and HAFAS documentation.
 
-## Frequently Asked Questions
+## Usage
 
-- [Why are there raw versions and formatted ones?](#why-are-there-raw-versions-and-formatted-ones)
+```py
-- [Some methods work slightly different](#some-methods-work-slightly-different)
+import pyrmv
-- [Documentation is not perfectly clear](#documentation-is-not-perfectly-clear)
 
-### Why are there raw versions and formatted ones?
+accessId = "Something" # Set API key
 
-For the purposes of my projects I don't really need all the stuff RMV gives (even though it's not much).
+# Get origin's and destination's location
-I only need some specific things. However I do understand that in some cases other users may find
+origin = pyrmv.raw.stop_by_name(accessid, "Frankfurt Hauptbahnhof", maxNo=3)[0]["StopLocation"]
-those methods quite useful so I implemented them as well.
+destination = pyrmv.raw.stop_by_coords(accessid, 50.099613, 8.685449, maxNo=3)[0]["StopLocation"]
 
-
+# Find a trip by locations got
-### Some methods work slightly different
+trip = pyrmv.raw.trip_find(accessId, originId=origin["id"], destExtId=destination["id"])
-
+```
-Can be. Not all function arguments written may work perfectly because I simply did not test each and
-every request. Some of arguments may be irrelevant in my use-case and the others are used quite rare at all.
-Just [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.
-
-### Documentation is not perfectly clear
-
-Of course docs cannot be perfect as a python docstring, especially if sometimes I don't
-know how things should correctly work. That's why you get HAFAS API docs in addition to your
-RMV API key. Just use my functions together with those docs, if you want to build something
-really sophisticated. However I'm not sure whether RMV supports that many HAFAS features publicly.
 """
 
 __name__ = "pyrmv"
-__version__ = "0.1.8"
+__version__ = "0.1.9"
 __license__ = "MIT License"
 __author__ = "Profitroll"
 
 from . import raw
 from . import errors
+from . import utility
+from . import methods
 from .methods import *

setup.py

@@ -2,10 +2,10 @@ from setuptools import setup
 
 setup(
     name="pyrmv",
-    version="0.1.8",
+    version="0.1.9",
     author="Profitroll",
     description="Small module that makes your journey with RMV REST API somehow easier.",
-    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="Small 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\naccessId = \"Something\" # Set API key\n\n# Get origin's and destination's location\norigin = pyrmv.raw.stop_by_name(accessid, \"Frankfurt Hauptbahnhof\", maxNo=3)[0][\"StopLocation\"]\ndestination = pyrmv.raw.stop_by_coords(accessid, 50.099613, 8.685449, maxNo=3)[0][\"StopLocation\"]\n\n# Find a trip by locations got\ntrip = pyrmv.raw.trip_find(accessId, originId=origin[\"id\"], destExtId=destination[\"id\"])\n```\n\n# Frequently Asked Questions\n\n- Why are there raw versions and formatted ones?\n- Some methods work slightly different\n- 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 (board_arrival)  \n- [ ] departureBoard (board_departure)  \n- [x] 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)",
     long_description_content_type="text/markdown",
     author_email="profitroll@end-play.xyz",
     url="https://git.end-play.xyz/profitroll/PythonRMV",
@@ -16,7 +16,10 @@ setup(
     },
     packages=[
         "pyrmv",
-        "pyrmv.raw"
+        "pyrmv.raw",
+        "pyrmv.errors",
+        "pyrmv.methods",
+        "pyrmv.utility"
     ],
     install_requires=[
         "requests",