Add extracted tools: CitrineOS, OpenOCPP, ShapeShifter
- CitrineOS core extracted (CSMS OCPP 2.0.1) - OpenOCPP extracted (firmware OCPP 1.6J/2.0.1) - ShapeShifter library installed (pip install -e) - ShapeShifter specification extracted - EVerest extracted TODO updated with progress
This commit is contained in:
Eric F
@@ -0,0 +1,255 @@
|
||||
Metadata-Version: 2.4
|
||||
Name: shapeshifter_uftp
|
||||
Version: 2.3.1
|
||||
Summary: Implementation of the Shapeshifter (UFTP) protocol
|
||||
License-Expression: Apache-2.0
|
||||
Project-URL: Repository, https://github.com/shapeshifter/shapeshifter-library-python
|
||||
Project-URL: Documentation, https://github.com/shapeshifter/shapeshifter-library-python/README.md
|
||||
Project-URL: Issues, https://github.com/shapeshifter/shapeshifter-library-python/issues
|
||||
Project-URL: Changelog, https://github.com/shapeshifter/shapeshifter-library-python/blob/main/CHANGELOG.md
|
||||
Requires-Python: <3.15,>=3.11
|
||||
Description-Content-Type: text/x-rst
|
||||
License-File: LICENSE
|
||||
Requires-Dist: xsdata[lxml]<27.0,>=25.0
|
||||
Requires-Dist: pynacl<=1.6.2,>=1.5.0
|
||||
Requires-Dist: dnspython==2.8.0
|
||||
Requires-Dist: fastapi<0.128,>=0.110
|
||||
Requires-Dist: fastapi-xml<2.0.0,>=1.1.1
|
||||
Requires-Dist: requests
|
||||
Requires-Dist: uvicorn
|
||||
Requires-Dist: termcolor
|
||||
Dynamic: license-file
|
||||
|
||||
Shapeshifter library for Python
|
||||
===============================
|
||||
|
||||
This is a Python implementation of the ShapeShifter UFTP protocol.
|
||||
|
||||
Overview
|
||||
--------
|
||||
|
||||
This library implements the full UFTP protocol that you can use for Shapeshifter communications. It implements all three roles: Distribution System Operator (**DSO**), Aggregator (**AGR**) and Common Reference Operator (**CRO**) in both directions (client and service).
|
||||
|
||||
Features of this package:
|
||||
|
||||
- Building, parsing and validation of the XML messages
|
||||
- Signing and verifying of the XML messages using signatures
|
||||
- DNS for service discovery and key retrieval
|
||||
- Convenient clients for each role-pair
|
||||
- Convenient services for each role
|
||||
- JSON-serializable dataclasses for easy transport to other systems
|
||||
- Fully internal queing system for full-duplex communication with minimal user code required
|
||||
- Compatible with version 3.0.0 and 3.1.0 of the Shapeshifter protocol.
|
||||
|
||||
|
||||
Installation
|
||||
------------
|
||||
|
||||
.. code-block:: python3
|
||||
|
||||
pip install shapeshifter-uftp
|
||||
|
||||
Running tests
|
||||
-------------
|
||||
|
||||
If you want to develop shapeshifter-uftp, you can fork or clone this repository and run the tests:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ pip install .
|
||||
$ pip install .[dev]
|
||||
$ pytest .
|
||||
|
||||
|
||||
Getting Started
|
||||
---------------
|
||||
|
||||
Shapehifter always requires the use of a Client and a Service, because all responses are asynchronous.
|
||||
|
||||
You choose the server class based on your role in the Shapeshifter conversation. If you are an Aggregator (also known as a CSP), you can use this setup:
|
||||
|
||||
.. code-block:: python3
|
||||
|
||||
from datetime import datetime, timedelta, timezone
|
||||
|
||||
from shapeshifter_uftp import ShapeshifterAgrService
|
||||
from shapeshifter_uftp.uftp import (FlexOffer, FlexOfferOption,
|
||||
FlexOfferOptionISP, FlexRequest,
|
||||
FlexRequestResponse, FlexOrder, FlexOrderResponse,
|
||||
AcceptedRejected)
|
||||
from xsdata.models.datatype import XmlDate
|
||||
|
||||
|
||||
class DemoAggregator(ShapeshifterAgrService):
|
||||
"""
|
||||
Aggregator service that implements callbacks for
|
||||
each of the messages that can be received.
|
||||
"""
|
||||
|
||||
def process_agr_portfolio_query_response(self, message):
|
||||
print(f"Received a message: {message}")
|
||||
|
||||
def process_agr_portfolio_update_response(self, message):
|
||||
print(f"Received a message: {message}")
|
||||
|
||||
def process_d_prognosis_response(self, message):
|
||||
print(f"Received a message: {message}")
|
||||
|
||||
def process_flex_request(self, message: FlexRequest):
|
||||
print(f"Received a message: {message}")
|
||||
|
||||
# Example of how to send a new message after
|
||||
# processing an incoming message.
|
||||
dso_client = self.dso_client(message.sender_domain)
|
||||
|
||||
# Send the FlexRequestResponse
|
||||
dso_client.send_flex_request_response(
|
||||
FlexRequestResponse(
|
||||
flex_request_message_id=message.message_id,
|
||||
conversation_id=message.conversation_id,
|
||||
result=AcceptedRejected.ACCEPTED
|
||||
)
|
||||
)
|
||||
|
||||
# Send the FlexOffer
|
||||
dso_client.send_flex_offer(
|
||||
FlexOffer(
|
||||
flex_request_message_id=message.message_id,
|
||||
conversation_id=message.conversation_id,
|
||||
isp_duration="PT15M",
|
||||
period=XmlDate(2023, 1, 1),
|
||||
congestion_point="ean.123456789012",
|
||||
expiration_date_time=datetime.now(timezone.utc).isoformat(),
|
||||
offer_options=[
|
||||
FlexOfferOption(
|
||||
isps=[FlexOfferOptionISP(power=1, start=1, duration=1)],
|
||||
option_reference="MyOption",
|
||||
price=2.30,
|
||||
min_activation_factor=0.5,
|
||||
)
|
||||
],
|
||||
)
|
||||
)
|
||||
|
||||
def process_flex_offer_response(self, message: FlexOffer):
|
||||
print(f"Received a message: {message}")
|
||||
|
||||
def process_flex_offer_revocation_response(self, message):
|
||||
print(f"Received a message: {message}")
|
||||
|
||||
def process_flex_order(self, message: FlexOrder):
|
||||
print(f"Received a message: {message}")
|
||||
|
||||
dso_client = self.dso_client(message.sender_domain)
|
||||
dso_client.send_flex_order_response(
|
||||
FlexOrderResponse(
|
||||
flex_order_message_id=message.message_id,
|
||||
conversation_id=message.conversation_id,
|
||||
result=AcceptedRejected.ACCEPTED
|
||||
)
|
||||
)
|
||||
|
||||
def process_flex_reservation_update(self, message):
|
||||
print(f"Received a message: {message}")
|
||||
|
||||
def process_flex_settlement(self, message):
|
||||
print(f"Received a message: {message}")
|
||||
|
||||
def process_metering_response(self, message):
|
||||
print(f"Received a message: {message}")
|
||||
|
||||
|
||||
def key_lookup(sender_domain, sender_role):
|
||||
"""
|
||||
Lookup function for public keys, so that incoming
|
||||
messages can be verified.
|
||||
"""
|
||||
known_senders = {
|
||||
("dso.demo", "DSO"): "NsTbq/iABU6tbsjriBg/Z5dSfQstulD0GpMI2fLDWec=",
|
||||
("cro.demo", "CRO"): "ySUYU87usErRFKGJafwvVDLGhnBVJCCNYfQvmwv8ObM=",
|
||||
}
|
||||
return known_senders.get((sender_domain, sender_role))
|
||||
|
||||
|
||||
def endpoint_lookup(sender_domain, sender_role):
|
||||
"""
|
||||
Lookup function for endpoints, so that the service
|
||||
knowns where to send responses to.
|
||||
"""
|
||||
known_senders = {
|
||||
("dso.demo", "DSO"): "http://localhost:8081/shapeshifter/api/v3/message",
|
||||
("cro.demo", "CRO"): "http://localhost:8082/shapeshifter/api/v3/message",
|
||||
}
|
||||
return known_senders.get((sender_domain, sender_role))
|
||||
|
||||
aggregator = DemoAggregator(
|
||||
sender_domain="aggregator.demo",
|
||||
signing_key="mz5XYCNKxpx48K+9oipUhsjBZed3L7rTVKLsWmG1HOqRLIeuGpIa1KAt6AlbVGqJvewd8v1J0uVUTqpGt7F8tw==",
|
||||
key_lookup_function=key_lookup,
|
||||
endpoint_lookup_function=endpoint_lookup,
|
||||
port=8080,
|
||||
)
|
||||
|
||||
# Start the Aggregator Service
|
||||
aggregator.run_in_thread()
|
||||
|
||||
# Create a client object to talk to a DSO
|
||||
dso_client = aggregator.dso_client("dso.demo")
|
||||
|
||||
# Create a Flex Offer Message
|
||||
flex_offer_message = FlexOffer(
|
||||
isp_duration="PT15M",
|
||||
period=XmlDate(2023, 1, 1),
|
||||
congestion_point="ean.123456789012",
|
||||
expiration_date_time=datetime.now(timezone.utc).isoformat(),
|
||||
flex_request_message_id=str(uuid4())
|
||||
offer_options=[
|
||||
FlexOfferOption(
|
||||
isps=[FlexOfferOptionISP(power=1, start=1, duration=1)],
|
||||
option_reference="MyOption",
|
||||
price=2.30,
|
||||
min_activation_factor=0.5,
|
||||
)
|
||||
],
|
||||
)
|
||||
|
||||
# As a demo, press enter to send another FlexOffer message to the DSO.
|
||||
while True:
|
||||
try:
|
||||
input("Press return to send a FlexOffer message to the DSO")
|
||||
response = dso_client.send_flex_offer(flex_offer_message)
|
||||
print(f"Response was: {response}")
|
||||
except:
|
||||
aggregator.stop()
|
||||
break
|
||||
|
||||
Using OAuth in outgoing requests
|
||||
--------------------------------
|
||||
|
||||
To use OAuth in outgoing requests, you can use the provided OAuthClient class. To use it in a bare Shapeshifter client:
|
||||
|
||||
.. code-block:: python3
|
||||
|
||||
from shapeshifter_uftp import ShapeshifterAgrDsoClient, OAuthClient
|
||||
|
||||
oauth_client = OAuthClient(
|
||||
url="https://oauth.provider.url",
|
||||
client_id="my-client-id",
|
||||
client_secret="my-client-secret"
|
||||
)
|
||||
|
||||
client = ShapeshifterAgrDsoClient(
|
||||
sender_domain="my.aggregator.domain",
|
||||
signing_key="abcdef",
|
||||
recipient_domain="some.dso",
|
||||
recipient_endpoint="https://some.dso.endpoint/shapeshifter/api/v3/message",
|
||||
recipient_signing_key="123456",
|
||||
oauth_client=oauth_client,
|
||||
)
|
||||
|
||||
# If you use any of the sending methods, the oauth client will
|
||||
# make sure you're authenticated.
|
||||
client.send_flex_request_response(...)
|
||||
|
||||
|
||||
Similarly, if you have a Service instance that dynamically needs to retrieve the OAuth information for each different recipient server, you can provide an ``oauth_lookup_function`` that takes a ``(sender_domain, sender_role)`` and returns an instance of OAuthClient.
|
||||
@@ -0,0 +1,66 @@
|
||||
LICENSE
|
||||
README.rst
|
||||
pyproject.toml
|
||||
shapeshifter_uftp/__init__.py
|
||||
shapeshifter_uftp/cli.py
|
||||
shapeshifter_uftp/exceptions.py
|
||||
shapeshifter_uftp/logging.py
|
||||
shapeshifter_uftp/oauth.py
|
||||
shapeshifter_uftp/transport.py
|
||||
shapeshifter_uftp.egg-info/PKG-INFO
|
||||
shapeshifter_uftp.egg-info/SOURCES.txt
|
||||
shapeshifter_uftp.egg-info/dependency_links.txt
|
||||
shapeshifter_uftp.egg-info/entry_points.txt
|
||||
shapeshifter_uftp.egg-info/requires.txt
|
||||
shapeshifter_uftp.egg-info/top_level.txt
|
||||
shapeshifter_uftp/client/__init__.py
|
||||
shapeshifter_uftp/client/agr_cro_client.py
|
||||
shapeshifter_uftp/client/agr_dso_client.py
|
||||
shapeshifter_uftp/client/base_client.py
|
||||
shapeshifter_uftp/client/cro_agr_client.py
|
||||
shapeshifter_uftp/client/cro_dso_client.py
|
||||
shapeshifter_uftp/client/dso_agr_client.py
|
||||
shapeshifter_uftp/client/dso_cro_client.py
|
||||
shapeshifter_uftp/service/__init__.py
|
||||
shapeshifter_uftp/service/agr_service.py
|
||||
shapeshifter_uftp/service/base_service.py
|
||||
shapeshifter_uftp/service/cro_service.py
|
||||
shapeshifter_uftp/service/dso_service.py
|
||||
shapeshifter_uftp/uftp/__init__.py
|
||||
shapeshifter_uftp/uftp/defaults.py
|
||||
shapeshifter_uftp/uftp/enums.py
|
||||
shapeshifter_uftp/uftp/validations.py
|
||||
shapeshifter_uftp/uftp/messages/__init__.py
|
||||
shapeshifter_uftp/uftp/messages/agr_portfolio_query.py
|
||||
shapeshifter_uftp/uftp/messages/agr_portfolio_update.py
|
||||
shapeshifter_uftp/uftp/messages/d_prognosis.py
|
||||
shapeshifter_uftp/uftp/messages/dso_portfolio_query.py
|
||||
shapeshifter_uftp/uftp/messages/dso_portfolio_update.py
|
||||
shapeshifter_uftp/uftp/messages/flex_message.py
|
||||
shapeshifter_uftp/uftp/messages/flex_offer.py
|
||||
shapeshifter_uftp/uftp/messages/flex_offer_revocation.py
|
||||
shapeshifter_uftp/uftp/messages/flex_order.py
|
||||
shapeshifter_uftp/uftp/messages/flex_request.py
|
||||
shapeshifter_uftp/uftp/messages/flex_reservation_update.py
|
||||
shapeshifter_uftp/uftp/messages/flex_settlement.py
|
||||
shapeshifter_uftp/uftp/messages/metering.py
|
||||
shapeshifter_uftp/uftp/messages/payload_message.py
|
||||
shapeshifter_uftp/uftp/messages/signed_message.py
|
||||
shapeshifter_uftp/uftp/messages/test_message.py
|
||||
test/test_cli.py
|
||||
test/test_client_errors.py
|
||||
test/test_client_with_workers.py
|
||||
test/test_clients_from_service.py
|
||||
test/test_communications.py
|
||||
test/test_default_responses.py
|
||||
test/test_message_destination.py
|
||||
test/test_oauth.py
|
||||
test/test_presence_of_client_methods.py
|
||||
test/test_presence_of_service_methods.py
|
||||
test/test_roundtrip_serialization.py
|
||||
test/test_seal_and_unseal.py
|
||||
test/test_service_errors.py
|
||||
test/test_snake_case.py
|
||||
test/test_ttl_cache.py
|
||||
test/test_validations.py
|
||||
test/test_xml_schema_compliance.py
|
||||
@@ -0,0 +1 @@
|
||||
|
||||
@@ -0,0 +1,3 @@
|
||||
[console_scripts]
|
||||
shapeshifter-keypair = shapeshifter_uftp.cli:generate_signing_keypair
|
||||
shapeshifter-lookup = shapeshifter_uftp.cli:perform_lookup
|
||||
@@ -0,0 +1,8 @@
|
||||
xsdata[lxml]<27.0,>=25.0
|
||||
pynacl<=1.6.2,>=1.5.0
|
||||
dnspython==2.8.0
|
||||
fastapi<0.128,>=0.110
|
||||
fastapi-xml<2.0.0,>=1.1.1
|
||||
requests
|
||||
uvicorn
|
||||
termcolor
|
||||
@@ -0,0 +1 @@
|
||||
shapeshifter_uftp
|
||||
Reference in New Issue
Block a user