catalog api

docs/source/api.rst

@@ -16,3 +16,4 @@ The application programming interface (API) is one of two modes of usage, next t
  process
  node
  sshconfig
+ catalog

docs/source/catalog.rst

@@ -0,0 +1,13 @@
+.. _catalog:
+
+Catalog
+=======
+
+*scherbelberg* offers facilities to get a list of available data center locations as well as lists of available server types per location plus their specifications and prices.
+
+Routines
+--------
+
+.. autofunction:: scherbelberg.get_locations
+
+.. autofunction:: scherbelberg.get_servertypes

src/scherbelberg/__init__.py

@@ -33,6 +33,10 @@
 # EXPORT
 # +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
+from ._core.catalog import (
+ get_locations,
+ get_servertypes,
+)
 from ._core.cluster import (
  Cluster,
  ClusterSchedulerNotFound,

src/scherbelberg/_core/catalog.py

@@ -0,0 +1,112 @@
+# -*- coding: utf-8 -*-
+
+"""
+
+SCHERBELBERG
+HPC cluster deployment and management for the Hetzner Cloud
+
+https://github.com/pleiszenburg/scherbelberg
+
+ src/scherbelberg/_core/catalog.py: List data centers and available types of servers
+
+ Copyright (C) 2021-2022 Sebastian M. Ernst <[email protected]>
+
+<LICENSE_BLOCK>
+The contents of this file are subject to the BSD 3-Clause License
+("License"). You may not use this file except in
+compliance with the License. You may obtain a copy of the License at
+https://github.com/pleiszenburg/scherbelberg/blob/master/LICENSE
+Software distributed under the License is distributed on an "AS IS" basis,
+WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the
+specific language governing rights and limitations under the License.
+</LICENSE_BLOCK>
+
+"""
+
+# +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# IMPORT
+# +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+from typing import Any, Dict, List, Optional
+
+from hcloud import Client
+from hcloud.server_types.client import ServerTypesClient
+from hcloud.server_types.domain import ServerType
+
+from hcloud.locations.client import LocationsClient
+from hcloud.locations.domain import Location
+
+from .debug import typechecked
+
+# +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# ROUTINES
+# +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+@typechecked
+def get_locations(client: Client) -> List[Dict[str, Any]]:
+ """
+ Queries a list of data center locations.
+
+ Args:
+ client : A cloud-API client object.
+ Returns:
+ Data center locations.
+ """
+
+ return [
+ _parse_location(location.data_model)
+ for location in LocationsClient(client).get_all()
+ ]
+
+@typechecked
+def get_servertypes(client: Client, location: str = 'fsn1') -> List[Dict[str, Any]]:
+ """
+ Queries a list of server types plus their specifications and prices.
+
+ Args:
+ client : A cloud-API client object.
+ location : Name of data center location.
+ Returns:
+ Server types plus their specifications and prices.
+ """
+
+ servertypes = ServerTypesClient(client).get_all()
+
+ servertypes = [_parse_model(servertype.data_model) for servertype in servertypes]
+
+ servertypes = [_parse_prices(servertype, location = location) for servertype in servertypes]
+ servertypes = [servertype for servertype in servertypes if servertype is not None]
+
+ return servertypes
+
+@typechecked
+def _parse_location(location: Location) -> Dict[str, Any]:
+ return {
+ attr: getattr(location, attr)
+ for attr in dir(location)
+ if not attr.startswith('_') and attr not in ('from_dict', 'id', 'id_or_name')
+ }
+
+@typechecked
+def _parse_model(model: ServerType) -> Dict[str, Any]:
+ model = {
+ attr: getattr(model, attr)
+ for attr in dir(model)
+ if not attr.startswith('_') and attr not in ('from_dict', 'id', 'id_or_name')
+ }
+ if model.get('deprecated', None) is None:
+ model['deprecated'] = False
+ return model
+
+@typechecked
+def _parse_prices(servertype: Dict[str, Any], location: str = 'fsn1') -> Optional[Dict[str, Any]]:
+ prices = servertype.pop('prices')
+ prices = {price['location']: price for price in prices if price['location'] == location}
+ if location not in prices.keys():
+ return None
+ price = prices[location]
+ price.pop('location')
+ for price_type in ('price_hourly', 'price_monthly'):
+ price.update({f'{price_type:s}_{k:s}': v for k, v in price.pop(price_type).items()})
+ servertype.update(price)
+ return servertype