clarify things

.gitignore

@@ -1,10 +1,3 @@
 # Byte-compiled Python
 __pycache__/
 *.pyc
-
-# Poetry venv directories and files
-.venv/
-poetry.lock
-
-# Keys and tokens of the Twitter API
-credentials.py

README.md

@@ -1,3 +1,13 @@
-# info_tbm
+# What's this?
 
-A twitter bot to know if my tram will arrive soon ⏰
+This is a set of libraries to gather real time data from TBM.
+
+They all work around [the dynamic map](https://www.infotbm.com/fr/plans/plan-dynamique/).
+
+## What's TBM?
+
+TBM is a French public transport company in Bordeaux.
+
+## Licence
+
+These libraries are under GNU GPL v3. See [license](LICENSE) for more details.

pyproject.toml

@@ -1,16 +0,0 @@
-[tool.poetry]
-name = "info_tbm"
-version = "0.1.0"
-description = ""
-authors = ["mdeboute <martin.deboute@gmail.com>"]
-
-[tool.poetry.dependencies]
-python = "^3.9"
-gmplot = "^1.4.1"
-tweepy = "^4.8.0"
-
-[tool.poetry.dev-dependencies]
-
-[build-system]
-requires = ["poetry-core>=1.0.0"]
-build-backend = "poetry.core.masonry.api"

src/autoreply.py

@@ -1,37 +0,0 @@
-import tweepy
-from config import *
-import time
-
-
-logging.basicConfig(level=logging.INFO)
-logger = logging.getLogger()
-
-
-def check_mentions(api, keywords, since_id):
-    logger.info("Retrieving mentions")
-    new_since_id = since_id
-    for tweet in tweepy.Cursor(api.mentions_timeline, since_id=since_id).items():
-        new_since_id = max(tweet.id, new_since_id)
-        if tweet.in_reply_to_status_id is not None:
-            continue
-        if any(keyword in tweet.text.lower() for keyword in keywords):
-            logger.info(f"Answering to {tweet.user.name}")
-            api.update_status(
-                status="Please reach us via DM",
-                in_reply_to_status_id=tweet.id,
-                auto_populate_reply_metadata=True,
-            )
-    return new_since_id
-
-
-def main():
-    api = create_api()
-    since_id = 1
-    while True:
-        since_id = check_mentions(api, ["help", "support"], since_id)
-        logger.info("Waiting...")
-        time.sleep(10)
-
-
-if __name__ == "__main__":
-    main()

src/config.py

@@ -1,19 +0,0 @@
-import tweepy
-import logging
-from credentials import *
-
-
-logger = logging.getLogger()
-
-
-def create_api():
-    auth = tweepy.OAuthHandler(CONSUMER_KEY, CONSUMER_SECRET)
-    auth.set_access_token(ACCESS_TOKEN, ACCESS_TOKEN_SECRET)
-    api = tweepy.API(auth, wait_on_rate_limit=True)
-    try:
-        api.verify_credentials()
-    except Exception as e:
-        logger.error("Error creating API", exc_info=True)
-        raise e
-    logger.info("API created")
-    return api

src/main.py

@@ -1,7 +1,7 @@
 import sys
-from tbm_api.stop_area import *
+from stop_area import *
-from tbm_api.stop import *
+from stop import *
-from tbm_api.stop_route import StopRoute
+from stop_route import StopRoute
 from datetime import datetime
 
 

src/stop.py

@@ -1,8 +1,8 @@
-from tbm_api.utils import get_data_from_json
+from utils import get_data_from_json
 from urllib.parse import quote
-from tbm_api.stop_point import StopPoint
+from stop_point import StopPoint
 from re import search
-from tbm_api.route import Route
+from route import Route
 
 
 INFO_URL = "https://ws.infotbm.com/ws/1.0/network/stoparea-informations/%s"

src/stop_area.py

@@ -1,4 +1,4 @@
-from tbm_api.utils import get_data_from_json
+from utils import get_data_from_json
 from urllib.parse import quote
 
 

src/stop_route.py

@@ -1,6 +1,6 @@
-from tbm_api.utils import get_data_from_json, hms2seconds
+from utils import get_data_from_json, hms2seconds
 from time import time
-from tbm_api.vehicle import Vehicle
+from vehicle import Vehicle
 
 
 SCHEDULE_URL = "https://ws.infotbm.com/ws/1.0/get-realtime-pass/%d/%s"
@@ -8,7 +8,7 @@ SCHEDULE_URL = "https://ws.infotbm.com/ws/1.0/get-realtime-pass/%d/%s"
 
 class Line:
     """
-    Information on the line served at a stop
+    Information on the line served at a stop.
     """
 
     def __init__(self, vehicles):
@@ -41,7 +41,7 @@ class StopRoute:
 
     def update(self, auto=False):
         """
-        Update data
+        Update data.
         """
 
         data = get_data_from_json(SCHEDULE_URL % (self.number, self.line))
@@ -80,7 +80,7 @@ class StopRoute:
 
     def data_age(self):
         """
-        Returns the age of the data
+        Returns the age of the data.
         """
 
         return time() - self.last_update

src/utils.py

@@ -5,7 +5,7 @@ from urllib.error import HTTPError
 
 def get_data_from_json(url):
     """
-    Gets data from json at url
+    Gets data from json at url.
     """
 
     opener = request.build_opener()
@@ -17,7 +17,7 @@ def get_data_from_json(url):
 
 def hms2seconds(hhmmss):
     """
-    Convert H:M:S string to time in seconds
+    Convert H:M:S string to time in seconds.
     """
 
     try:

src/vcub.py

@@ -1,33 +1,17 @@
 """
-Provides all info about V³ stations
+Provides all info about V³ stations.
 """
 
-from tbm_api.utils import get_data_from_json
+from utils import get_data_from_json
 from time import time
 
+
 vcub_url = "https://ws.infotbm.com/ws/1.0/vcubs"
 
 
 class Vcub:
     """
-    Retrieves information from V³ stations
+    Retrieves information from V³ stations.
-
-    Data format, as returned by the infotbm website:
-    {
-            lists: [
-                    {
-                            'id': station number,
-                            'name': str,
-                            'connexionState': 'CONNECTED' if in service 'DISCONNECTED' otherwise,
-                            'typeVlsPlus': 'VLS_PLUS' if V³+ 'PAS_VLS_PLUS' otherwise,
-                            'nbPlaceAvailable': 33,
-                            'nbBikeAvailable': 0
-                            'nbElectricBikeAvailable': 6
-                            'latitude': float,
-                            'longitude': float,
-                    },
-            ]
-    }
     """
 
     def __init__(
@@ -49,9 +33,7 @@ class Vcub:
 
     def update(self, auto=False, data=None):
         """
-        Updates data
+        Updates data.
-        auto optionnal param is to set if a update is a automatic one,
-        and must be performed as defined in autoupdate_delay variable
         """
 
         if data is None or type(data) != dict:
@@ -77,14 +59,14 @@ class Vcub:
 
     def data_age(self):
         """
-        Computes the data's age
+        Computes the data's age.
         """
 
         return time() - self.last_update
 
     def get_names(self):
         """
-        Returns all names in a dict with id as data
+        Returns all names in a dict with id as data.
         """
 
         r = {}
@@ -94,7 +76,7 @@ class Vcub:
 
     def get_locations(self):
         """
-        Returns all locations in a dict with id as data
+        Returns all locations in a dict with id as data.
         """
 
         r = {}
@@ -104,7 +86,7 @@ class Vcub:
 
     def get_by_id(self, id):
         """
-        Returns a station by its id
+        Returns a station by its id.
         """
 
         class Station: