@@ -1017,12 +1017,12 @@ <h2 id="installation">📦 Installation<a class="headerlink" href="#installation
10171017</ span > </ code > </ pre > </ div >
10181018< h2 id ="usage "> 🛠️ Usage< a class ="headerlink " href ="#usage " title ="Permanent link "> ¤</ a > </ h2 >
10191019< p > Here's a quick example to get you started:</ p >
1020- < div class ="language-python highlight "> < pre > < span > </ span > < code > < span id ="__span-1-1 "> < a id ="__codelineno-1-1 " name ="__codelineno-1-1 " href ="#__codelineno-1-1 "> </ a > < span class ="kn "> from</ span > < span class ="w "> </ span > < span class ="nn "> frequenz.client.dispatch</ span > < span class ="w "> </ span > < span class ="kn "> import</ span > < span class ="n "> Client </ span >
1020+ < div class ="language-python highlight "> < pre > < span > </ span > < code > < span id ="__span-1-1 "> < a id ="__codelineno-1-1 " name ="__codelineno-1-1 " href ="#__codelineno-1-1 "> </ a > < span class ="kn "> from</ span > < span class ="w "> </ span > < span class ="nn "> frequenz.client.dispatch</ span > < span class ="w "> </ span > < span class ="kn "> import</ span > < span class ="n "> DispatchApiClient </ span >
10211021</ span > < span id ="__span-1-2 "> < a id ="__codelineno-1-2 " name ="__codelineno-1-2 " href ="#__codelineno-1-2 "> </ a > < span class ="kn "> import</ span > < span class ="w "> </ span > < span class ="nn "> asyncio</ span >
10221022</ span > < span id ="__span-1-3 "> < a id ="__codelineno-1-3 " name ="__codelineno-1-3 " href ="#__codelineno-1-3 "> </ a >
10231023</ span > < span id ="__span-1-4 "> < a id ="__codelineno-1-4 " name ="__codelineno-1-4 " href ="#__codelineno-1-4 "> </ a > < span class ="k "> async</ span > < span class ="k "> def</ span > < span class ="w "> </ span > < span class ="nf "> print_dispatches</ span > < span class ="p "> ():</ span >
10241024</ span > < span id ="__span-1-5 "> < a id ="__codelineno-1-5 " name ="__codelineno-1-5 " href ="#__codelineno-1-5 "> </ a > < span class ="c1 "> # Initialize the client</ span >
1025- </ span > < span id ="__span-1-6 "> < a id ="__codelineno-1-6 " name ="__codelineno-1-6 " href ="#__codelineno-1-6 "> </ a > < span class ="n "> client</ span > < span class ="o "> =</ span > < span class ="n "> Client </ span > < span class ="p "> (</ span > < span class ="n "> key</ span > < span class ="o "> =</ span > < span class ="s2 "> "your_api_key"</ span > < span class ="p "> ,</ span > < span class ="n "> server_url</ span > < span class ="o "> =</ span > < span class ="s2 "> "grpc://fz-0004. frequenz.io "</ span > < span class ="p "> )</ span >
1025+ </ span > < span id ="__span-1-6 "> < a id ="__codelineno-1-6 " name ="__codelineno-1-6 " href ="#__codelineno-1-6 "> </ a > < span class ="n "> client</ span > < span class ="o "> =</ span > < span class ="n "> DispatchApiClient </ span > < span class ="p "> (</ span > < span class ="n "> key</ span > < span class ="o "> =</ span > < span class ="s2 "> "your_api_key"</ span > < span class ="p "> ,</ span > < span class ="n "> server_url</ span > < span class ="o "> =</ span > < span class ="s2 "> "grpc://dispatch.eu-1.prod.api. frequenz.com:443 "</ span > < span class ="p "> )</ span >
10261026</ span > < span id ="__span-1-7 "> < a id ="__codelineno-1-7 " name ="__codelineno-1-7 " href ="#__codelineno-1-7 "> </ a >
10271027</ span > < span id ="__span-1-8 "> < a id ="__codelineno-1-8 " name ="__codelineno-1-8 " href ="#__codelineno-1-8 "> </ a > < span class ="c1 "> # List all dispatches for a specific microgrid</ span >
10281028</ span > < span id ="__span-1-9 "> < a id ="__codelineno-1-9 " name ="__codelineno-1-9 " href ="#__codelineno-1-9 "> </ a > < span class ="k "> async</ span > < span class ="k "> for</ span > < span class ="n "> page</ span > < span class ="ow "> in</ span > < span class ="n "> client</ span > < span class ="o "> .</ span > < span class ="n "> list</ span > < span class ="p "> (</ span > < span class ="n "> microgrid_id</ span > < span class ="o "> =</ span > < span class ="mi "> 1</ span > < span class ="p "> ):</ span >
@@ -1032,7 +1032,7 @@ <h2 id="usage">🛠️ Usage<a class="headerlink" href="#usage" title="Permanent
10321032</ span > < span id ="__span-1-13 "> < a id ="__codelineno-1-13 " name ="__codelineno-1-13 " href ="#__codelineno-1-13 "> </ a > < span class ="c1 "> # Run the Example</ span >
10331033</ span > < span id ="__span-1-14 "> < a id ="__codelineno-1-14 " name ="__codelineno-1-14 " href ="#__codelineno-1-14 "> </ a > < span class ="n "> asyncio</ span > < span class ="o "> .</ span > < span class ="n "> run</ span > < span class ="p "> (</ span > < span class ="n "> print_dispatches</ span > < span class ="p "> ())</ span >
10341034</ span > </ code > </ pre > </ div >
1035- < p > For detailed usage and advanced features, check out the < a href ="https://frequenz-floss.github.io/frequenz-client-dispatch-python/latest/reference/frequenz/client/dispatch/#frequenz.client.dispatch.Client "> client documentation</ a > .</ p >
1035+ < p > For detailed usage and advanced features, check out the < a href ="https://frequenz-floss.github.io/frequenz-client-dispatch-python/latest/reference/frequenz/client/dispatch/#frequenz.client.dispatch.ApiDispatchClient "> client documentation</ a > .</ p >
10361036< h2 id ="supported-platforms "> 🌐 Supported Platforms< a class ="headerlink " href ="#supported-platforms " title ="Permanent link "> ¤</ a > </ h2 >
10371037< p > We officially support and test the following platforms:</ p >
10381038< ul >
0 commit comments