dimo-python-sdk 0.0.1__tar.gz

dimo_python_sdk-0.0.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 DIMO Foundation
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

dimo_python_sdk-0.0.1/PKG-INFO

@@ -0,0 +1,385 @@
+Metadata-Version: 2.1
+Name: dimo-python-sdk
+Version: 0.0.1
+Summary: DIMO SDK in Python
+Author-email: Barrett Kowalsky <barrettkowalsky@gmail.com>
+Project-URL: Homepage, https://github.com/DIMO-Network/dimo-python-sdk
+Project-URL: Issues, https://github.com/DIMO-Network/dimo-python-sdk/issues
+Keywords: dimo,sdk,python,depin,web3
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.30.0
+Requires-Dist: web3>=6.20.0
+
+# DIMO Python Developer SDK
+
+## Installation
+
+You can install the SDK using `pip`
+
+```bash
+pip install dimo-python-sdk
+```
+
+## Unit Testing
+
+Coming Soon
+
+## API Documentation
+
+Please visit the DIMO [Developer Documentation](https://docs.dimo.zone/developer-platform) to learn more about building on DIMO and detailed information on the API.
+
+## How to Use the SDK
+
+Importing the SDK:
+
+```python
+from dimo import DIMO
+```
+
+Initiate the SDK depending on the envionrment of your interest, we currently support both `Production` and `Dev` environments:
+
+```python
+dimo = DIMO("Production")
+```
+
+or
+
+```python
+dimo = DIMO("Dev")
+```
+
+### Developer License
+
+As part of the authentication process, you will need to register a set of `client_id` and `redirect_uri` (aka `domain`) on the DIMO Network. The [DIMO Developer License](https://docs.dimo.zone/developer-platform/getting-started/developer-license) is our approach and design to a more secured, decentralized access control. As a developer, you will need to perform the following steps:
+
+1. [Approving the Dev License to use of $DIMO](https://docs.dimo.zone/developer-platform/getting-started/developer-license/licensing-process#step-1-approving-the-dev-license-to-use-of-usddimo)
+2. [Issue the Dev License](https://docs.dimo.zone/developer-platform/getting-started/developer-license/licensing-process#step-2-issue-the-dev-license) (Get a `client_id` assigned to you)
+3. [Configuring the Dev License](https://docs.dimo.zone/developer-platform/getting-started/developer-license/licensing-process#step-3-configuring-the-dev-license) (Set `redirect_uri` aka `domain`)
+4. [Enable Signer(s)](https://docs.dimo.zone/developer-platform/getting-started/developer-license/licensing-process#step-4-enable-signer-s), the `private_key` of this signer will be required for API access
+
+### DIMO Streams
+
+Coming Soon
+
+### Authentication
+
+In order to authenticate and access private API data, you will need to [authenticate with the DIMO Auth Server](https://docs.dimo.zone/developer-platform/getting-started/authentication). The SDK provides you with all the steps needed in the [Wallet-based Authentication Flow](https://docs.dimo.zone/developer-platform/getting-started/authentication/wallet-based-authentication-flow) in case you need it to build a wallet integration around it. We also offer expedited functions to streamline the multiple calls needed.
+
+#### Prerequisites for Authentication
+
+1. A valid Developer License.
+2. Access to a signer wallet and its private keys. Best practice is to rotate this frequently for security purposes.
+
+> At its core, a Web3 wallet is a software program that stores private keys, which are necessary for accessing blockchain networks and conducting transactions. Unlike traditional wallets, which store physical currency, Web3 wallets store digital assets such as Bitcoin, Ethereum, and NFTs.
+
+NOTE: The signer wallet here is recommended to be different from the spender or holder wallet for your [DIMO Developer License](https://github.com/DIMO-Network/developer-license-donotus).
+
+#### API Authentication
+
+##### (Option 1) 3-Step Function Calls
+
+The SDK offers 3 basic functions that maps to the steps listed in [Wallet-based Authentication Flow](https://docs.dimo.zone/developer-platform/getting-started/authentication/wallet-based-authentication-flow): `generate_challenge`, `sign_challenge`, and `submit_challenge`. You can use them accordingly depending on how you build your application.
+
+```python
+    challenge = await dimo.auth.generate_challenge(
+        client_id: '<client_id>',
+        domain: '<domain>',
+        address: '<address>'
+    )
+
+    signature = await dimo.auth.sign_challenge(
+        message: challenge['challenge'],
+        private_key: '<private_key>'
+    )
+
+    tokens = await dimo.auth.submit_challenge(
+        client_id: '<client_id>',
+        domain: '<domain>',
+        state: challenge['state'],
+        signature: signature
+    )
+```
+
+##### (Option 2) Auth Endpoint Shortcut Function
+
+As mentioned earlier, this is the streamlined function call to directly get the `access_token`. The `address` field in challenge generation is omitted since it is essentially the `client_id` of your application per Developer License:
+
+```python
+auth_header = await dimo.auth.get_token(
+    client_id: '<client_id>',
+    domain: '<domain>',
+    private_key: '<private_key>'
+)
+
+# Store the access_token from the auth_header dictionary
+access_token = auth_header["access_token"]
+```
+
+##### (Option 3) Credentials.json File
+
+Coming Soon
+
+### Querying the DIMO REST API
+
+The SDK supports async/await syntax using the [asyncio](https://docs.python.org/3/library/asyncio.html) library, and for making HTTP requests using the [requests](https://requests.readthedocs.io/en/latest/) library.
+
+```python
+async def main():
+    device_makes = await dimo.device_definitions.list_device_makes()
+    # Do something with the response
+
+if __name__ == "__main__":
+        asyncio.run(main())
+```
+
+#### Query Parameters
+
+For query parameters, simply feed in an input that matches with the expected query parameters:
+
+```python
+await dimo.device_definitions.get_by_mmy(
+    make="<vehicle_make>",
+    model="<vehicle_model>",
+    year=2024
+)
+```
+
+#### Path Parameters
+
+Path parameters work similarly - simply feed in an input, such as id.
+
+```python
+await dimo.device_definitions.get_by_id(id='26G4j1YDKZhFeCsn12MAlyU3Y2H')
+```
+
+#### Body Parameters
+
+#### Privilege Tokens
+
+As the 2nd leg of the API authentication, applications may exchange for short-lived privilege tokens for specific vehicles that granted privileges to the app. This uses the [DIMO Token Exchange API](https://docs.dimo.zone/developer-platform/api-references/dimo-protocol/token-exchange-api/token-exchange-api-endpoints).
+
+For the end users of your application, they will need to share their vehicle permissions via the DIMO Mobile App or through your own implementation of privilege sharing functions - this should be built on the [`setPrivilege` function of the DIMO Vehicle Smart Contract](https://polygonscan.com/address/0xba5738a18d83d41847dffbdc6101d37c69c9b0cf#writeProxyContract).
+
+Typically, any endpoints that uses a NFT `tokenId` in path parameters will require privilege tokens. You can get the privilege token and pipe it through to corresponding endpoints like this:
+
+```python
+privilege_token = await dimo.token_exchange.exchange(access_token, privileges=[1,3,4], token_id=<vehicle_token_id>)
+
+await dimo.device_data.get_vehicle_status(token=privilege_token, vehicle_id=<vehicle_token_id>)
+```
+
+### Querying the DIMO GraphQL API
+
+The SDK accepts any type of valid custom GraphQL queries, but we've also included a few sample queries to help you understand the DIMO GraphQL APIs.
+
+#### Authentication for GraphQL API
+
+The GraphQL entry points are designed almost identical to the REST API entry points. For any GraphQL API that requires auth headers (Telemetry API for example), you can use the same pattern as you would in the REST protected endpoints.
+
+```python
+privilege_token = await dimo.token_exchange.exchange(access_token, privileges=[1,3,4], token_id=<vehicle_token_id>)
+
+telemetry = await dimo.telemetry.query(
+    token=privilege_token,
+    query= """
+        query {
+            some_valid_GraphQL_query
+            }
+        """
+    )
+```
+
+#### Send a custom GraphQL query
+
+To send a custom GraphQL query, you can simply call the `query` function on any GraphQL API Endpoints and pass in any valid GraphQL query. To check whether your GraphQL query is valid, please visit our [Identity API GraphQL Playground](https://identity-api.dimo.zone/) or [Telemetry API GraphQL Playground](https://telemetry-api.dimo.zone/).
+
+```python
+my_query = """
+    {
+    vehicles (first:10) {
+        totalCount
+        }
+    }
+    """
+
+total_network_vehicles = await dimo.identity.query(query=my_query)
+```
+
+#### Built in graphQL Queries: Identity API (Common Queries)
+
+##### .count_dimo_vehicles()
+
+Returns the first 10 vehicles
+
+_Example:_
+
+```python
+first_10_vehicles = await dimo.identity.count_dimo_vehicles()
+```
+
+##### .list_vehicle_definitions_per_address()
+
+Requires an **address** and a **limit**. Returns vehicle definitions (limited by requested limit) for the given owner address.
+
+_Example:_
+
+```python
+my_vehicle_definitions = await dimo.identity.list_vehicle_definitions_per_address(
+    address = "<0x address>",
+    limit = 10
+)
+```
+
+##### .mmy_by_owner()
+
+Requires an **address** and a **limit**. Returns the makes, models, and years(limited by requested limit) for the given owner address.
+
+_Example:_
+
+```python
+my_mmy = await dimo.identity.mmy_by_owner(
+    address = "<0x address>",
+    limit = 10
+)
+```
+
+##### .list_token_ids_privileges_by_owner()
+
+Requires an **address** a **vehicle_limit**, and a **privileges_limit**. Returns the Token IDs and privileges for a given owner address.
+
+_Example:_
+
+```python
+my_vehicle_id_and_privileges = await dimo.identity.list_vehicle_definitions_per_address(
+    address = "<0x address>",
+    vehicle_limit = 4,
+    privileges_limit = 4,
+)
+```
+
+##### .list_token_ids_granted_to_dev_by_owner()
+
+Requires a **dev_address**, **owner_address**, and **limit**. Returns the Token IDs granted to a developer from an owner.
+
+_Example:_
+
+```python
+my_vehicle_definitions = await dimo.identity.list_token_ids_granted_to_dev_by_owner(
+    dev_address = "<0x dev address>",
+    owner_address = "0x owner address>",
+    limit = 10
+)
+```
+
+##### .dcn_by_owner()
+
+Requires an **address** and **limit**. Returns a list of DCNs attached to the vehicles owned for a given owner.
+
+_Example:_
+
+```python
+my_vehicle_definitions = await dimo.identity.dcn_by_owner(
+    address = "<0x address>",
+    limit = 10
+)
+```
+
+##### .mmy_by_token_id
+
+Requires a **token_id**. Returns the make, model, year and Token IDs for a given vehicle Token ID.
+
+_Example:_
+
+```python
+my_mmy_token_id = await dimo.identity.mmy_by_token_id(token_id=21957)
+```
+
+##### .rewards_by_owner
+
+Requires an **address**. Returns the rewards data for a given owner.
+
+_Example:_
+
+```python
+my_rewards = await dimo.identity.rewards_by_owner(address="<0x address>")
+```
+
+##### .rewards_history_by_owner
+
+Requires an **address** and **limit**. Returns the rewards history data for a given owner.
+
+_Example:_
+
+```python
+my_rewards_history = await dimo.identity.rewards_history_by_owner(address="<0x address>", limit=50)
+```
+
+#### Built in graphQL Queries: Telemetry API (Common Queries)
+
+Note, that the below queries for the Telemetry API require providing a privilege token (see above on how to obtain this token.)
+
+##### .get_signals_latest()
+
+Requires a **privilege_token** and **token_id**. Returns latest vehicle signals based on a provided Token ID.
+
+_Example:_
+
+```python
+my_latest_signals = await dimo.telemetry.get_signals_latest(
+    token=my_privileged_token, token_id=12345)
+```
+
+##### .get_daily_signals_autopi()
+
+Requires a **privilege_token**, **token_id**, **start_date**, and **end_date**. Returns daily vehicle signals based on the specified time range for an autopi device.
+
+_Example:_
+
+```python
+my_daily_signals = await dimo.telemetry.get_daily_signals_autopi(
+    token=my_privileged_token,
+    token_id=12345,
+    start_date="2024-07-04T18:00:00Z",
+    end_date="2024-07-12T18:00:00Z")
+```
+
+##### .get_daily_average_speed()
+
+Requires a **privilege_token**, **token_id**, **start_date**, and **end_date**. Returns the daily average speed for a specified vehicle, based on the specified time range.
+
+_Example:_
+
+```python
+my_daily_avg_speed = await dimo.telemetry.get_daily_avg_speed(
+    token=my_privileged_token,
+    token_id=12345,
+    start_date="2024-07-04T18:00:00Z",
+    end_date="2024-07-12T18:00:00Z")
+```
+
+##### .get_daily_max_speed()
+
+Requires a **privilege_token**, **token_id**, **start_date**, and **end_date**. Returns the daily MAX speed for a specified vehicle, based on the specified time range.
+
+_Example:_
+
+```python
+my_daily_max_speed = await dimo.telemetry.get_daily_max_speed(
+    token=my_privileged_token,
+    token_id=12345,
+    start_date="2024-07-04T18:00:00Z",
+    end_date="2024-07-12T18:00:00Z")
+```
+
+## How to Contribute to the SDK
+
+You can read more about contributing [here](https://github.com/DIMO-Network/dimo-python-sdk/blob/dev-barrettk/CONTRIBUTING.md)
+
+```
+
+```