tesla-fleet-api 0.0.1__tar.gz → 0.0.4__tar.gz

{tesla_fleet_api-0.0.1/tesla_fleet_api.egg-info → tesla_fleet_api-0.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tesla_fleet_api
-Version: 0.0.1
+Version: 0.0.4
 Summary: Tesla Fleet API library for Python
 Home-page: https://github.com/Teslemetry/tesla_fleet_api
 Author: Brett Adams
@@ -15,12 +15,16 @@ License-File: LICENSE
 Requires-Dist: aiohttp
 
 # tesla_fleet_api
-Python library for Tesla Fleet API and Teslemetry
+Python library for Tesla Fleet API and Teslemetry.
 
-Currently does not support the End to End encrypted Telemetry or Command API.
+Currently does not support the end to end encrypted telemetry or command API.
 
 Based on [Tesla Developer documentation](https://developer.tesla.com/docs/fleet-api).
 
+
+## TeslaFleetApi
+This is the base class, however can also be used directly if you have a valid user access_token.
+
 ```
 import asyncio
 import aiohttp
@@ -45,3 +49,33 @@ async def main():
 
 asyncio.run(main())
 ```
+
+## TeslaFleetOAuth
+This extends TeslaFleetApi to support OAuth, and requires a client_id, and either a refresh_token or initial authentication code.
+
+## Teslemetry
+This extends TeslaFleetApi to send requests through Teslemetry, which manages all aspects of Tesla OAuth. This class only requires an access_token from the Teslemetry console.
+
+```
+import asyncio
+import aiohttp
+
+from tesla_fleet_api import Teslemetry, TeslaFleetError
+
+
+async def main():
+    async with aiohttp.ClientSession() as session:
+        api = Teslemetry(
+            access_token="<access_token>",
+            session=session,
+            raise_for_status=True,
+        )
+
+        try:
+            data = await api.vehicle.list()
+            print(data)
+        except TeslaFleetError.Base as e:
+            print(e.message, e.error)
+
+asyncio.run(main())
+```

tesla_fleet_api-0.0.4/README.md

@@ -0,0 +1,65 @@
+# tesla_fleet_api
+Python library for Tesla Fleet API and Teslemetry.
+
+Currently does not support the end to end encrypted telemetry or command API.
+
+Based on [Tesla Developer documentation](https://developer.tesla.com/docs/fleet-api).
+
+
+## TeslaFleetApi
+This is the base class, however can also be used directly if you have a valid user access_token.
+
+```
+import asyncio
+import aiohttp
+
+from tesla_fleet_api import TeslaFleetApi, TeslaFleetError
+
+
+async def main():
+    async with aiohttp.ClientSession() as session:
+        api = TeslaFleetApi(
+            access_token="<access_token>",
+            session=session,
+            region="na",
+            raise_for_status=True,
+        )
+
+        try:
+            data = await api.vehicle.list()
+            print(data)
+        except TeslaFleetError.Base as e:
+            print(e.message, e.error)
+
+asyncio.run(main())
+```
+
+## TeslaFleetOAuth
+This extends TeslaFleetApi to support OAuth, and requires a client_id, and either a refresh_token or initial authentication code.
+
+## Teslemetry
+This extends TeslaFleetApi to send requests through Teslemetry, which manages all aspects of Tesla OAuth. This class only requires an access_token from the Teslemetry console.
+
+```
+import asyncio
+import aiohttp
+
+from tesla_fleet_api import Teslemetry, TeslaFleetError
+
+
+async def main():
+    async with aiohttp.ClientSession() as session:
+        api = Teslemetry(
+            access_token="<access_token>",
+            session=session,
+            raise_for_status=True,
+        )
+
+        try:
+            data = await api.vehicle.list()
+            print(data)
+        except TeslaFleetError.Base as e:
+            print(e.message, e.error)
+
+asyncio.run(main())
+```

{tesla_fleet_api-0.0.1 → tesla_fleet_api-0.0.4}/setup.py

@@ -5,7 +5,7 @@ with open("README.md", "r") as fh:
 
 setuptools.setup(
     name="tesla_fleet_api",
-    version="0.0.1",
+    version="0.0.4",
     author="Brett Adams",
     author_email="hello@teslemetry.com",
     description="Tesla Fleet API library for Python",