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

Configured license and versions

Browse Source
This commit is contained in:
Profitroll 2022-09-22 18:35:21 +02:00
parent cbf52503fe
commit 64328261ab
3 changed files with 13 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
LICENSE
View File

@ -1,6 +1,6 @@
MIT License MIT License
Copyright (c) <year> <copyright holders> Copyright (c) 2022 END PLAY Studio
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

26
__init__.py
View File

@ -1,11 +1,7 @@
""" """
## PythonRMV ## PythonRMV
Small module that makes your journey with RMV REST API somehow easier. Small module that makes your journey with RMV REST API somehow easier. Based fully on official RMV API reference and HAFAS documentation.
## Get started
As you can guess you need to have RMV API key. You can get it for free on the [RMV website](https://opendata.rmv.de/site/start.html).
## Frequently Asked Questions ## Frequently Asked Questions
@ -16,25 +12,27 @@ As you can guess you need to have RMV API key. You can get it for free on the [R
### Why are there raw versions and formatted ones? ### Why are there raw versions and formatted ones?
For the purposes of my projects I don't really need all the stuff RMV gives (even though it's not much). For the purposes of my projects I don't really need all the stuff RMV gives (even though it's not much).
I only need some specific things and the rest I don't even need. However I do understand that in some I only need some specific things. However I do understand that in some cases other users may find
cases other users may find those methods quite useful so I implemented them too. those methods quite useful so I implemented them as well.
### Some methods work slightly different ### Some methods work slightly different
Can be. Not all the arguments written may work perfectly because I simply did not test them all. Can be. Not all function arguments written may work perfectly because I simply did not test each and
Some of them may be irrelevant in my use-case and the others are used quite rare at all. 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. 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 ### Documentation is not perfectly clear
Of course docs cannot be perfect in the format of python docstring, especially if I also don't always Of course docs cannot be perfect as a python docstring, especially if sometimes I don't
know how things should correctly work so that's why you get HAFAS API docs together with your 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 in connection with those docs, if you want to build something RMV API key. Just use my functions together with those docs, if you want to build something
actually sophisticated. But remember, that I wrote all of that without sophistication in mind. really sophisticated. However I'm not sure whether RMV supports that many HAFAS features publicly.
""" """
__version__ = "0.1" __name__ = "pyrmv"
__version__ = "0.1.0"
__license__ = "MIT License"
__author__ = "Profitroll" __author__ = "Profitroll"
from . import raw from . import raw

9
raw/__init__.py
View File

@ -1,12 +1,3 @@
"""
## PythonRMV Raw
All available RMV API methods. Raw. In the same place.
"""
__version__ = "0.1"
__author__ = "Profitroll"
from .boardArrival import boardArrival from .boardArrival import boardArrival
from .boardDeparture import boardDeparture from .boardDeparture import boardDeparture
from .findRoute import findRoute from .findRoute import findRoute