diff --git a/LICENSE b/LICENSE index 2071b23..31f709b 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) +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: diff --git a/__init__.py b/__init__.py index 591cc0d..9d8c014 100644 --- a/__init__.py +++ b/__init__.py @@ -1,11 +1,7 @@ """ ## PythonRMV -Small module that makes your journey with RMV REST API somehow easier. - -## 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). +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 @@ -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? 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 -cases other users may find those methods quite useful so I implemented them too. +I only need some specific things. However I do understand that in some cases other users may find +those methods quite useful so I implemented them as well. ### Some methods work slightly different -Can be. Not all the arguments written may work perfectly because I simply did not test them all. -Some of them may be irrelevant in my use-case and the others are used quite rare at all. +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 in the format of python docstring, especially if I also don't always -know how things should correctly work so that's why you get HAFAS API docs together with your -RMV API key. Just use my functions in connection with those docs, if you want to build something -actually sophisticated. But remember, that I wrote all of that without sophistication in mind. +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. """ -__version__ = "0.1" +__name__ = "pyrmv" +__version__ = "0.1.0" +__license__ = "MIT License" __author__ = "Profitroll" from . import raw \ No newline at end of file diff --git a/raw/__init__.py b/raw/__init__.py index df8aa06..27a64da 100644 --- a/raw/__init__.py +++ b/raw/__init__.py @@ -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 .boardDeparture import boardDeparture from .findRoute import findRoute