179D updates

README.rst

@@ -9,6 +9,15 @@ Py-SEED
 
 A python API client for the SEED Platform. This is an updated version of the Client. It is compatible with the latest version of the SEED Platform (>2.17.4). This client still has access to the previous format of generating a lower level API client by accessing `seed_client_base.SEEDOAuthReadOnlyClient`, `seed_client_base.SEEDOAuthReadWriteClient`, `seed_client_base.SEEDReadOnlyClient`, and `seed_client_base.SEEDReadWriteClient`. This lower level API is documented below under the `Low-Level Documentation`
 
+Stakeholders
+-------------
+
+The following list of stakeholders should be considered when making changes to this module
+
+- 179D Tax Deduction Web Application
+- Earth Advantage Green Building Registry
+- User scripts for managing building data
+
 Documentation
 -------------
 The SEED client is a read-write client. To install the client run:

pyseed/seed_client.py

@@ -116,7 +116,7 @@ def read_connection_config_file(cls, filepath: Path) -> dict:
                 "api_key": "1b5ea1ee220c8628789c61d66253d90398e6ad03",
                 "port": 8000,
                 "use_ssl": false,
-                "seed_org_name: "test-org"
+                "seed_org_name": "test-org"
             }
 
         Args:
@@ -273,10 +273,12 @@ def get_property(self, property_id: int) -> dict:
         )
 
     def search_buildings(
-        self, identifier_filter: str = None, identifier_exact: str = None
+        self, identifier_filter: str = None, identifier_exact: str = None, cycle_id: int = None
     ) -> dict:
-        payload = {
-            "cycle": self.cycle_id,
+        if not cycle_id:
+            cycle_id = self.cycle_id
+        payload: Dict[str, Any] = {
+            "cycle": cycle_id,
         }
         if identifier_filter is not None:
             payload["identifier"] = identifier_filter
@@ -494,6 +496,46 @@ def update_labels_of_buildings(
         )
         return result
 
+    def create_building(self, params: dict) -> list:
+        """
+        Creates a building with unique ID (either pm_property_id or custom_id_1 for now)
+        Expects params to contain a state dictionary and a cycle id
+        Optionally pass in a cycle ID
+
+        Returns the created property_view id
+        """
+        # first try matching on custom_id_1
+        matching_id = params.get('state', {}).get('custom_id_1', None)
+
+        if not matching_id:
+            # then try on pm_property_id
+            matching_id = params.get('state', {}).get('pm_property_id', None)
+
+            if not matching_id:
+                raise Exception(
+                    "This property does not have a pm_property_id or a custom_id_1 for matching...cannot create."
+                )
+
+        cycle_id = params.get('cycle_id', None)
+        # include appropriate cycle in search (if not using the default cycle set on the class)
+        buildings = self.search_buildings(identifier_exact=matching_id, cycle_id=cycle_id)
+
+        if len(buildings) > 0:
+            raise Exception(
+                "A property matching the provided matching ID (pm_property_id or custom_id_1) already exists."
+            )
+
+        results = self.client.post(endpoint="properties", json=params)
+        return results
+
+    def update_building(self, id, params: dict) -> list:
+        """
+        Updates a building's property_view
+        Expects id and params to contain a state dictionary
+        """
+        results = self.client.put(id, endpoint="properties", json=params)
+        return results
+
     def get_cycles(self) -> list:
         """Return a list of all the cycles for the organization.
 

pyseed/seed_client_base.py

@@ -213,7 +213,7 @@ def _check_response(self, response, *args, **kwargs):
         error = False
         error_msg = 'Unknown error from SEED API'
         # OK, Created, Accepted
-        if response.status_code not in [200, 201, 202]:
+        if response.status_code not in [200, 201, 202, 204]:
             error = True
             error_msg = 'SEED returned status code: {}'.format(response.status_code)
         # SEED adds a status key to the response to indicate success/error

tests/test_seed_client.py

@@ -114,6 +114,68 @@ def test_search_buildings(self):
         properties = self.seed_client.search_buildings(identifier_filter="B-1")
         assert len(properties) == 2
 
+    def test_create_update_building(self):
+        # create a new building (property, propertyState, propertyView)
+        # Update the building
+        completion_date = "02/02/2023"
+        year = '2023'
+        print(f" ORGANIZATION: {self.organization_id}")
+        cycle = self.seed_client.get_or_create_cycle(
+            "pyseed-api-integration-test",
+            date(int(year), 1, 1),
+            date(int(year), 12, 31),
+            set_cycle_id=True,
+        )
+
+        state = {
+            "organization_id": self.organization_id,
+            "custom_id_1": "123456",
+            "address_line_1": "123 Testing St",
+            "city": "Beverly Hills",
+            "state": "CA",
+            "postal_code": "90210",
+            "property_name": "Test Building",
+            "property_type": None,
+            "gross_floor_area": None,
+            "conditioned_floor_area": None,
+            "occupied_floor_area": None,
+            "site_eui": None,
+            "site_eui_modeled": None,
+            "source_eui_weather_normalized": None,
+            "source_eui": None,
+            "source_eui_modeled": None,
+            "site_eui_weather_normalized": None,
+            "total_ghg_emissions": None,
+            "total_marginal_ghg_emissions": None,
+            "total_ghg_emissions_intensity": None,
+            "total_marginal_ghg_emissions_intensity": None,
+            "generation_date": None,
+            "recent_sale_date": None,
+            "release_date": None,
+            "extra_data": {
+                "pathway": "new",
+                "completion_date": completion_date
+            }
+        }
+
+        params = {'state': state, 'cycle_id': cycle["id"]}
+
+        result = self.seed_client.create_building(params=params)
+        assert result["status"] == "success"
+        assert result["view"]["id"] is not None
+        view_id = result["view"]["id"]
+
+        # update that property (by ID)
+        state['property_name'] = 'New Name Building'
+
+        properties = self.seed_client.search_buildings(identifier_exact=state['custom_id_1'])
+        assert len(properties) == 1
+
+        params2 = {'state': state}
+        result2 = self.seed_client.update_building(view_id, params=params2)
+        # print(f" !!! results2 are: {result2}")
+        assert result2["status"] == "success"
+
     def test_add_label_to_buildings(self):
         # get seed buildings
         prop_ids = []