From 930157bad365e640e7d10f4cf2736a997e4fe153 Mon Sep 17 00:00:00 2001 From: Profitroll <47523801+profitrollgame@users.noreply.github.com> Date: Thu, 22 Sep 2022 19:27:34 +0200 Subject: [PATCH] Tree changed once more --- .gitignore | 4 +++- __init__.py => pyrmv/__init__.py | 2 +- {raw => pyrmv/raw}/__init__.py | 0 {raw => pyrmv/raw}/boardArrival.py | 0 {raw => pyrmv/raw}/boardDeparture.py | 0 {raw => pyrmv/raw}/findRoute.py | 0 {raw => pyrmv/raw}/himSearch.py | 0 {raw => pyrmv/raw}/journeyDetail.py | 0 {raw => pyrmv/raw}/stopByCoords.py | 0 {raw => pyrmv/raw}/stopByName.py | 0 setup.cfg | 3 +++ setup.py | 14 +++++++++++++- 12 files changed, 20 insertions(+), 3 deletions(-) rename __init__.py => pyrmv/__init__.py (97%) rename {raw => pyrmv/raw}/__init__.py (100%) rename {raw => pyrmv/raw}/boardArrival.py (100%) rename {raw => pyrmv/raw}/boardDeparture.py (100%) rename {raw => pyrmv/raw}/findRoute.py (100%) rename {raw => pyrmv/raw}/himSearch.py (100%) rename {raw => pyrmv/raw}/journeyDetail.py (100%) rename {raw => pyrmv/raw}/stopByCoords.py (100%) rename {raw => pyrmv/raw}/stopByName.py (100%) create mode 100644 setup.cfg diff --git a/.gitignore b/.gitignore index 62125b5..f4c20b1 100644 --- a/.gitignore +++ b/.gitignore @@ -155,4 +155,6 @@ cython_debug/ # Custom tests -test_all.py \ No newline at end of file +test_all.py +build.* +cleanup.* \ No newline at end of file diff --git a/__init__.py b/pyrmv/__init__.py similarity index 97% rename from __init__.py rename to pyrmv/__init__.py index 9d8c014..f87bb61 100644 --- a/__init__.py +++ b/pyrmv/__init__.py @@ -31,7 +31,7 @@ really sophisticated. However I'm not sure whether RMV supports that many HAFAS """ __name__ = "pyrmv" -__version__ = "0.1.0" +__version__ = "0.1.6" __license__ = "MIT License" __author__ = "Profitroll" diff --git a/raw/__init__.py b/pyrmv/raw/__init__.py similarity index 100% rename from raw/__init__.py rename to pyrmv/raw/__init__.py diff --git a/raw/boardArrival.py b/pyrmv/raw/boardArrival.py similarity index 100% rename from raw/boardArrival.py rename to pyrmv/raw/boardArrival.py diff --git a/raw/boardDeparture.py b/pyrmv/raw/boardDeparture.py similarity index 100% rename from raw/boardDeparture.py rename to pyrmv/raw/boardDeparture.py diff --git a/raw/findRoute.py b/pyrmv/raw/findRoute.py similarity index 100% rename from raw/findRoute.py rename to pyrmv/raw/findRoute.py diff --git a/raw/himSearch.py b/pyrmv/raw/himSearch.py similarity index 100% rename from raw/himSearch.py rename to pyrmv/raw/himSearch.py diff --git a/raw/journeyDetail.py b/pyrmv/raw/journeyDetail.py similarity index 100% rename from raw/journeyDetail.py rename to pyrmv/raw/journeyDetail.py diff --git a/raw/stopByCoords.py b/pyrmv/raw/stopByCoords.py similarity index 100% rename from raw/stopByCoords.py rename to pyrmv/raw/stopByCoords.py diff --git a/raw/stopByName.py b/pyrmv/raw/stopByName.py similarity index 100% rename from raw/stopByName.py rename to pyrmv/raw/stopByName.py diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..fe869c8 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,3 @@ +[metadata] +description_file=README.md +license_files=LICENSE \ No newline at end of file diff --git a/setup.py b/setup.py index 9c58cb4..0e26bec 100644 --- a/setup.py +++ b/setup.py @@ -2,10 +2,22 @@ from setuptools import setup setup( name="pyrmv", - version="0.1.0", + version="0.1.6", 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# 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- [ ] arrivalBoard (boardArrival) \n- [ ] departureBoard (boardArrival) \n- [x] himsearch (himSearch) \n- [ ] journeyDetail \n- [x] location.nearbystops (stopByCoords) \n- [x] location.name (stopByName) \n- [ ] recon \n- [x] trip (findRoute)", + long_description_content_type="text/markdown", author_email="profitroll@end-play.xyz", + url="https://git.end-play.xyz/profitroll/pyrmv", + project_urls={ + "Bug Tracker": "https://git.end-play.xyz/profitroll/pyrmv/issues", + "Documentation": "https://git.end-play.xyz/profitroll/pyrmv/wiki", + "Source Code": "https://git.end-play.xyz/profitroll/pyrmv.git", + }, + packages=[ + "pyrmv", + "pyrmv.raw" + ], install_requires=[ "requests", "xmltodict"