profitroll/PythonRMV
profitroll/PythonRMV
1
1
Fork 0
Code Issues Pull Requests Actions Packages Releases 3 Wiki Activity

Updated to version 0.2.0

Browse Source
This commit is contained in:
Profitroll 2022-09-23 22:58:05 +02:00
parent da21f3ad77
commit 977ac2d559
3 changed files with 12 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -25,7 +25,8 @@ If you have everything listed in [requirements](#requirements), then let's begin
```py ```py
import pyrmv import pyrmv
accessId = "Something" # Set API key # Set API key
accessId = "Something"
# Get origin's and destination's location # Get origin's and destination's location
origin = pyrmv.raw.stop_by_name(accessid, "Frankfurt Hauptbahnhof", maxNo=3)[0]["StopLocation"] origin = pyrmv.raw.stop_by_name(accessid, "Frankfurt Hauptbahnhof", maxNo=3)[0]["StopLocation"]

11
pyrmv/__init__.py
View File

@ -8,19 +8,20 @@ Small module that makes your journey with RMV REST API somehow easier. Based ful
```py ```py
import pyrmv import pyrmv
accessId = "Something" # Set API key # Set API key
accessId = "Something"
# Get origin's and destination's location # Get origin's and destination's location
origin = pyrmv.raw.stop_by_name(accessid, "Frankfurt Hauptbahnhof", maxNo=3)[0]["StopLocation"] origin = pyrmv.raw.stop_by_name(accessid, "Frankfurt Hauptbahnhof", maxNo=1)[0]
destination = pyrmv.raw.stop_by_coords(accessid, 50.099613, 8.685449, maxNo=3)[0]["StopLocation"] destination = pyrmv.raw.stop_by_coords(accessid, 50.099613, 8.685449, maxNo=1)[0]
# Find a trip by locations got # Find a trip by locations got
trip = pyrmv.raw.trip_find(accessId, originId=origin["id"], destExtId=destination["id"]) trip = pyrmv.raw.trip_find(accessId, originId=origin.id, destExtId=destination.id)
``` ```
""" """
__name__ = "pyrmv" __name__ = "pyrmv"
__version__ = "0.1.9" __version__ = "0.2.0"
__license__ = "MIT License" __license__ = "MIT License"
__author__ = "Profitroll" __author__ = "Profitroll"

7
setup.py
View File

@ -2,10 +2,10 @@ from setuptools import setup
setup( setup(
name="pyrmv", name="pyrmv",
version="0.1.9", version="0.2.0",
author="Profitroll", author="Profitroll",
description="Small module that makes your journey with RMV REST API somehow easier.", 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# 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="## 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\naccessId = \"Something\"\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", long_description_content_type="text/markdown",
author_email="profitroll@end-play.xyz", author_email="profitroll@end-play.xyz",
url="https://git.end-play.xyz/profitroll/PythonRMV", url="https://git.end-play.xyz/profitroll/PythonRMV",
@ -23,7 +23,8 @@ setup(
], ],
install_requires=[ install_requires=[
"requests", "requests",
"xmltodict" "xmltodict",
"isodate"
], ],
classifiers=[ classifiers=[
"Development Status :: 1 - Planning", "Development Status :: 1 - Planning",