Improved README
This commit is contained in:
Profitroll
parent
3599a034dc
commit
80a788933d
48
README.md
48
README.md
|
|
@ -2,25 +2,27 @@
|
|||
|
||||
Small module that makes your journey with RMV REST API somehow easier. Based fully on official RMV API reference and HAFAS documentation.
|
||||
|
||||
# Requirements
|
||||
## Requirements
|
||||
|
||||
* RMV API key (Get it [here](https://opendata.rmv.de/site/start.html))
|
||||
* Python3 (Tested versions are 3.7.9 and 3.9.13)
|
||||
* git (Only for installation from source)
|
||||
|
||||
# Installation
|
||||
## Installation
|
||||
|
||||
If you have everything listed in [requirements](#requirements), then let's begin.
|
||||
|
||||
### Variant 1:
|
||||
### Variant 1
|
||||
|
||||
1. `python -m pip install pyrmv`
|
||||
|
||||
### Variant 2:
|
||||
### Variant 2
|
||||
|
||||
1. `git clone https://git.end-play.xyz/profitroll/PythonRMV.git`
|
||||
2. `cd PythonRMV`
|
||||
3. `python setup.py install`
|
||||
|
||||
# Usage
|
||||
## Usage
|
||||
|
||||
```py
|
||||
import pyrmv
|
||||
|
|
@ -36,44 +38,26 @@ destination = client.stop_by_coords(50.099613, 8.685449, max_number=3)[0]
|
|||
trip = client.trip_find(origin_id=origin.id, dest_id=destination.id)
|
||||
```
|
||||
|
||||
# Frequently Asked Questions
|
||||
## Frequently Asked Questions
|
||||
|
||||
- [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)
|
||||
* [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)
|
||||
|
||||
## 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).
|
||||
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
|
||||
### Some methods work slightly different
|
||||
|
||||
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.
|
||||
|
||||
# To-Do
|
||||
## General
|
||||
- [ ] Docs in Wiki
|
||||
## To-Do
|
||||
|
||||
## Raw methods
|
||||
- [x] arrivalBoard (board_arrival)
|
||||
- [x] departureBoard (board_departure)
|
||||
- [x] himsearch (him_search)
|
||||
- [x] journeyDetail (journey_detail)
|
||||
- [x] location.nearbystops (stop_by_coords)
|
||||
- [x] location.name (stop_by_name)
|
||||
- [x] trip (trip_find)
|
||||
- [x] recon (trip_recon)
|
||||
### General
|
||||
|
||||
## Normal methods
|
||||
- [x] arrivalBoard (board_arrival)
|
||||
- [x] departureBoard (board_departure)
|
||||
- [x] himsearch (him_search)
|
||||
- [x] journeyDetail (journey_detail)
|
||||
- [x] location.nearbystops (stop_by_coords)
|
||||
- [x] location.name (stop_by_name)
|
||||
- [x] trip (trip_find)
|
||||
- [x] recon (trip_recon)
|
||||
* [ ] Docs in Wiki
|
||||
* [ ] Tickets
|
||||
|
|
|
|||
2
setup.py
2
setup.py
|
|
@ -5,7 +5,7 @@ setup(
|
|||
version="0.3.1",
|
||||
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# 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="Small module that makes your journey with RMV REST API somehow easier. Based fully on official RMV API reference and HAFAS documentation.\n\n## Requirements\n\n* RMV API key (Get it [here](https://opendata.rmv.de/site/start.html))\n* Python3 (Tested versions are 3.7.9 and 3.9.13)\n* git (Only for installation from source)\n\n## Installation\n\nIf you have everything listed in [requirements](#requirements), then let's begin.\n\n### Variant 1\n\n1. `python -m pip install pyrmv`\n\n### Variant 2\n\n1. `git clone https://git.end-play.xyz/profitroll/PythonRMV.git`\n2. `cd PythonRMV`\n3. `python setup.py install`\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?](#why-are-there-raw-versions-and-formatted-ones)\n* [Some methods work slightly different](#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### 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\n### General\n\n* [ ] Docs in Wiki\n* [ ] Tickets",
|
||||
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