Updated readme to 0.3.0
This commit is contained in:
parent
ed44947277
commit
551babedb7
10
README.md
10
README.md
|
|
@ -40,7 +40,6 @@ trip = client.trip_find(origin_id=origin.id, dest_id=destination.id)
|
|||
|
||||
- [Why are there raw versions and formatted ones?](#why-are-there-raw-versions-and-formatted-ones)
|
||||
- [Some methods work slightly different](#some-methods-work-slightly-different)
|
||||
- [Documentation is not perfectly clear](#documentation-is-not-perfectly-clear)
|
||||
|
||||
## Why are there raw versions and formatted ones?
|
||||
|
||||
|
|
@ -55,13 +54,6 @@ Can be. Not all function arguments written may work perfectly because I simply d
|
|||
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.
|
||||
|
||||
# To-Do
|
||||
## General
|
||||
- [ ] Docs in Wiki
|
||||
|
|
@ -79,7 +71,7 @@ really sophisticated. However I'm not sure whether RMV supports that many HAFAS
|
|||
## Normal methods
|
||||
- [x] arrivalBoard (board_arrival)
|
||||
- [x] departureBoard (board_departure)
|
||||
- [ ] himsearch (him_search)
|
||||
- [x] himsearch (him_search)
|
||||
- [x] journeyDetail (journey_detail)
|
||||
- [x] location.nearbystops (stop_by_coords)
|
||||
- [x] location.name (stop_by_name)
|
||||
|
|
|
|||
|
|
@ -8,15 +8,15 @@ Small module that makes your journey with RMV REST API somehow easier. Based ful
|
|||
```py
|
||||
import pyrmv
|
||||
|
||||
# Set API key
|
||||
access_id = "Something"
|
||||
# Define a Client with API key
|
||||
client = pyrmv.Client("AcessId")
|
||||
|
||||
# Get origin's and destination's location
|
||||
origin = pyrmv.stop_by_name(access_id, "Frankfurt Hauptbahnhof", max_number=3)[0]
|
||||
destination = pyrmv.stop_by_coords(access_id, 50.099613, 8.685449, max_number=3)[0]
|
||||
origin = client.stop_by_name("Frankfurt Hauptbahnhof", max_number=3)[0]
|
||||
destination = client.stop_by_coords(50.099613, 8.685449, max_number=3)[0]
|
||||
|
||||
# Find a trip by locations got
|
||||
trip = pyrmv.trip_find(access_id, origin_id=origin.id, dest_id=destination.id)
|
||||
trip = client.trip_find(origin_id=origin.id, dest_id=destination.id)
|
||||
```
|
||||
"""
|
||||
|
||||
|
|
|
|||
2
setup.py
2
setup.py
|
|
@ -5,7 +5,7 @@ setup(
|
|||
version="0.3.0",
|
||||
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# Define a Client with API key\nclient = pyrmv.Client(\"AccessId\")\n\n# Get origin's and destination's location\norigin = client.stop_by_name(\"Frankfurt Hauptbahnhof\", max_number=3)[0]\ndestination = client.stop_by_coords(50.099613, 8.685449, max_number=3)[0]\n\n# Find a trip by locations got\ntrip = client.trip_find(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- [x] arrivalBoard (board_arrival) \n- [x] departureBoard (board_departure) \n- [ ] 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)",
|
||||
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\n# Define a Client with API key\nclient = pyrmv.Client(\"AcessId\")\n\n# Get origin's and destination's location\norigin = client.stop_by_name(\"Frankfurt Hauptbahnhof\", max_number=3)[0]\ndestination = client.stop_by_coords(50.099613, 8.685449, max_number=3)[0]\n\n# Find a trip by locations got\ntrip = client.trip_find(origin_id=origin.id, dest_id=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\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# 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- [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)",
|
||||
long_description_content_type="text/markdown",
|
||||
author_email="profitroll@end-play.xyz",
|
||||
url="https://git.end-play.xyz/profitroll/PythonRMV",
|
||||
|
|
|
|||
Loading…
Reference in New Issue