hydroserverpy 0.3.0__py3-none-any.whl → 0.5.0b1__py3-none-any.whl

hydroserverpy/core/schemas/things.py

@@ -1,309 +0,0 @@
-from pydantic import BaseModel, Field, AliasPath, AliasChoices, field_validator
-from typing import Optional, List, Literal, IO, TYPE_CHECKING
-from uuid import UUID
-from country_list import countries_for_language
-from hydroserverpy.core.schemas.base import HydroServerCoreModel, HydroServerBaseModel
-
-if TYPE_CHECKING:
-    from hydroserverpy.core.schemas.datastreams import Datastream
-
-
-class ThingFields(BaseModel):
-    name: str = Field(
-        ..., strip_whitespace=True, max_length=200,
-        description='The name of the site/thing.'
-    )
-    description: str = Field(
-        ..., strip_whitespace=True,
-        description='A description of the site/thing.'
-    )
-    sampling_feature_type: str = Field(
-        ..., strip_whitespace=True, max_length=200,
-        description='The sampling feature type of the site/thing.'
-    )
-    sampling_feature_code: str = Field(
-        ..., strip_whitespace=True, max_length=200,
-        description='A code representing the sampling feature of the site/thing.'
-    )
-    site_type: str = Field(
-        ..., strip_whitespace=True, max_length=200,
-        description='The type of the site/thing.'
-    )
-    data_disclaimer: Optional[str] = Field(
-        None, strip_whitespace=True,
-        description='An optional data disclaimer to attach to observations collected at this site/thing.'
-    )
-
-
-# Get a list of all ISO 3166-1 alpha-2 country codes
-valid_country_codes = [code for code, _ in countries_for_language('en')]
-
-
-class LocationFields(BaseModel):
-    latitude: float = Field(
-        ..., ge=-90, le=90, serialization_alias='latitude',
-        validation_alias=AliasChoices('latitude', AliasPath('location', 'latitude')),
-        description='The WGS84 latitude of the location.'
-    )
-    longitude: float = Field(
-        ..., ge=-180, le=180, serialization_alias='longitude',
-        validation_alias=AliasChoices('longitude', AliasPath('location', 'longitude')),
-        description='The WGS84 longitude of the location.'
-    )
-    elevation_m: Optional[float] = Field(
-        None, ge=-99999, le=99999, serialization_alias='elevation_m',
-        validation_alias=AliasChoices('elevation_m', AliasPath('location', 'elevation_m')),
-        description='The elevation in meters of the location.'
-    )
-    elevation_datum: Optional[str] = Field(
-        None, strip_whitespace=True, max_length=255, serialization_alias='elevationDatum',
-        validation_alias=AliasChoices('elevationDatum', AliasPath('location', 'elevationDatum')),
-        description='The datum used to represent the elevation of the location.'
-    )
-    state: Optional[str] = Field(
-        None, strip_whitespace=True, max_length=200, serialization_alias='state',
-        validation_alias=AliasChoices('state', AliasPath('location', 'state')),
-        description='The state/province of the location.'
-    )
-    county: Optional[str] = Field(
-        None, strip_whitespace=True, max_length=200, serialization_alias='county',
-        validation_alias=AliasChoices('county', AliasPath('location', 'county')),
-        description='The county/district of the location.'
-    )
-    country: Optional[str] = Field(
-        None, strip_whitespace=True, max_length=2, serialization_alias='country',
-        validation_alias=AliasChoices('country', AliasPath('location', 'country')),
-        description='The ISO 3166-1 alpha-2 country code of the location.'
-    )
-
-    @field_validator('country', mode='after')
-    def check_country_code(cls, value: str) -> str:
-        """
-        Validate the country code to ensure it is an ISO 3166-1 alpha-2 country code.
-
-        :param value: The country code to validate.
-        :type value: Optional[str]
-        :raises ValueError: If the country code is invalid.
-        :return: The validated country code.
-        :rtype: Optional[str]
-        """
-
-        if value and value.upper() not in valid_country_codes:
-            raise ValueError(f'Invalid country code: {value}. Must be an ISO 3166-1 alpha-2 country code.')
-
-        return value
-
-
-class Thing(HydroServerCoreModel, ThingFields, LocationFields):
-    """
-    A model representing a site/thing, combining core attributes from ThingFields and LocationFields with methods for
-    interacting with related entities.
-
-    :ivar _datastreams: A private attribute to cache the list of datastreams associated with the thing.
-    :ivar _tags: A private attribute to cache the list of tags associated with the thing.
-    :ivar _photos: A private attribute to cache the list of photos associated with the thing.
-    :ivar _archive: A private attribute to cache the archive associated with the thing.
-    """
-
-    def __init__(self, _endpoint, _uid: Optional[UUID] = None, **data):
-        """
-        Initialize a Thing instance.
-
-        :param _endpoint: The endpoint associated with the thing.
-        :type _endpoint: str
-        :param _uid: The unique identifier for the thing.
-        :type _uid: Optional[UUID]
-        :param data: Additional attributes for the thing.
-        """
-
-        super().__init__(_endpoint=_endpoint, _uid=_uid, **data)
-        self._datastreams = None
-        self._tags = None
-        self._photos = None
-        self._archive = None
-
-    @property
-    def datastreams(self) -> List['Datastream']:
-        """
-        The datastreams associated with the thing. If not already cached, fetch the datastreams from the
-        server.
-
-        :return: A list of datastreams associated with the thing.
-        :rtype: List[Datastream]
-        """
-
-        if self._datastreams is None:
-            self._datastreams = self._endpoint.list_datastreams(uid=self.uid)
-
-        return self._datastreams
-
-    @property
-    def tags(self) -> List['Tag']:
-        """
-        The tags associated with the thing. If not already cached, fetch the tags from the server.
-
-        :return: A list of tags associated with the thing.
-        :rtype: List[Tag]
-        """
-
-        if self._tags is None:
-            self._tags = self._endpoint.list_tags(uid=self.uid)
-
-        return self._tags
-
-    @property
-    def photos(self) -> List['Photo']:
-        """
-        The photos associated with the thing. If not already cached, fetch the photos from the server.
-
-        :return: A list of photos associated with the thing.
-        :rtype: List[Photo]
-        """
-
-        if self._photos is None:
-            self._photos = self._endpoint.list_photos(uid=self.uid)
-
-        return self._photos
-
-    @property
-    def archive(self) -> 'Archive':
-        """
-        The archive associated with the thing. If not already cached, fetch the archive from the server.
-
-        :return: The archive associated with the thing.
-        :rtype: Archive
-        """
-
-        if self._archive is None:
-            self._archive = self._endpoint.get_archive(uid=self.uid)
-
-        return self._archive
-
-    def refresh(self) -> None:
-        """
-        Refresh the thing with the latest data from the server and update cached datastreams, tags, photos, and archive
-        if they were previously loaded.
-        """
-
-        entity = self._endpoint.get(uid=self.uid).model_dump(exclude=['uid'])
-        self._original_data = entity
-        self.__dict__.update(entity)
-        if self._datastreams is not None:
-            self._datastreams = self._endpoint.list_datastreams(uid=self.uid)
-        if self._tags is not None:
-            self._tags = self._endpoint.list_tags(uid=self.uid)
-        if self._photos is not None:
-            self._photos = self._endpoint.list_photos(uid=self.uid)
-        if self._archive is not None:
-            self._archive = self._endpoint.get_archive(uid=self.uid)
-
-    def add_tag(self, key: str, value: str) -> None:
-        """
-        Add a new tag to the thing.
-
-        :param key: The key of the new tag.
-        :param value: The value of the new tag.
-        """
-
-        if self.tags is not None:
-            new_tag = self._endpoint.create_tag(uid=self.uid, key=key, value=value)
-            self._tags.append(new_tag)
-
-    def update_tag(self, key: str, value: str) -> None:
-        """
-        Update the value of an existing tag on the thing.
-
-        :param key: The key of the tag to update.
-        :param value: The new value for the tag.
-        """
-
-        selected_tag = next((tag for tag in self._tags if tag.key == key))
-        updated_tag = self._endpoint.update_tag(uid=self.uid, tag_uid=selected_tag.uid, value=value)
-        self._tags = [tag if tag.key != key else updated_tag for tag in self._tags]
-
-    def delete_tag(self, key: str) -> None:
-        """
-        Delete a tag from the thing.
-
-        :param key: The key of the tag to delete.
-        """
-
-        selected_tag = next((tag for tag in self._tags if tag.key == key))
-        self._endpoint.delete_tag(uid=self.uid, tag_uid=selected_tag.uid)
-        self._tags = [tag for tag in self._tags if tag.key != selected_tag.key]
-
-    def add_photo(self, photo: IO) -> None:
-        """
-        Add a photo to the thing.
-
-        :param photo: The photo file to upload.
-        :type photo: IO
-        """
-
-        if self.photos is not None:
-            photos = self._endpoint.upload_photo(uid=self.uid, file=photo)
-            self._photos.extend(photos)
-
-    def delete_photo(self, link: str) -> None:
-        """
-        Delete a photo from the thing.
-
-        :param link: The link to the photo to delete.
-        """
-
-        selected_photo = next((photo for photo in self._photos if photo.link == link))
-        self._endpoint.delete_photo(uid=self.uid, photo_uid=selected_photo.uid)
-        self._photos = [photo for photo in self._photos if photo.link != selected_photo.link]
-
-
-class Archive(HydroServerBaseModel):
-    """
-    A model representing an archive associated with a thing.
-    """
-
-    link: Optional[str] = Field(
-        None, strip_whitespace=True, max_length=255,
-        description='A link to the HydroShare resource containing the archived site/thing.'
-    )
-    frequency: Optional[Literal['daily', 'weekly', 'monthly']] = Field(
-        ...,
-        description='The frequency at which the site/thing should be archived.',
-    )
-    path: str = Field(
-        ..., strip_whitespace=True, max_length=255,
-        description='The path within the HydroShare resource containing the archived data.'
-    )
-    datastream_ids: List[UUID] = Field(
-        ...,
-        description='The list of datastreams that are included in the archived data.',
-    )
-
-
-class Tag(HydroServerBaseModel):
-    """
-    A model representing a tag associated with a thing.
-    """
-
-    key: str = Field(
-        ..., strip_whitespace=True, max_length=255,
-        description='The key of the tag.'
-    )
-    value: str = Field(
-        ..., strip_whitespace=True, max_length=255,
-        description='The value of the tag.'
-    )
-
-
-class Photo(HydroServerBaseModel):
-    """
-    A model representing a photo associated with a thing.
-    """
-
-    file_path: str = Field(
-        ..., strip_whitespace=True,
-        description='The file path of the photo.'
-    )
-    link: str = Field(
-        ..., strip_whitespace=True,
-        description='The link to the photo.'
-    )

hydroserverpy/core/schemas/units.py

@@ -1,30 +0,0 @@
-from pydantic import Field
-from hydroserverpy.core.schemas.base import HydroServerCoreModel
-
-
-class UnitFields:
-    name: str = Field(
-        ..., strip_whitespace=True, max_length=255,
-        description='The name of the unit.'
-    )
-    symbol: str = Field(
-        ..., strip_whitespace=True, max_length=255,
-        description='The symbol of the unit.'
-    )
-    definition: str = Field(
-        ..., strip_whitespace=True,
-        description='The definition of the unit.'
-    )
-    type: str = Field(
-        ..., strip_whitespace=True, max_length=255,
-        description='The type of the unit.'
-    )
-
-
-class Unit(HydroServerCoreModel, UnitFields):
-    """
-    A model representing a unit, extending the core functionality of HydroServerCoreModel with additional
-    fields defined in UnitFields.
-    """
-
-    pass

hydroserverpy/core/service.py

@@ -1,186 +0,0 @@
-import requests
-from typing import Optional
-from hydroserverpy.core.endpoints import (DataLoaderEndpoint, DataSourceEndpoint, DatastreamEndpoint, ThingEndpoint,
-                                          SensorEndpoint, UnitEndpoint, ProcessingLevelEndpoint,
-                                          ObservedPropertyEndpoint, ResultQualifierEndpoint)
-
-
-class HydroServer:
-    """
-    Connects to a HydroServer instance and used to interact with HydroServer's Data Management API endpoints.
-
-    :param host: The base URL or host of the HydroServer API.
-    :type host: str
-    :param username: The username for basic authentication, if required.
-    :type username: Optional[str]
-    :param password: The password for basic authentication, if required.
-    :type password: Optional[str]
-    :param apikey: The API key for authentication, if using API key authentication.
-    :type apikey: Optional[str]
-    :param api_route: The API route to use, default is 'api'.
-    :type api_route: str
-    """
-
-    def __init__(
-            self,
-            host: str,
-            username: Optional[str] = None,
-            password: Optional[str] = None,
-            apikey: Optional[str] = None,
-            api_route: str = 'api'
-    ):
-        self.host = host.strip('/')
-        self.auth = (username or '__key__', password or apikey,) if (username and password) or apikey else None
-        self.api_route = api_route.strip('/')
-        self._session = None
-        self._timeout = 60
-        self._initialize_session()
-
-    def _initialize_session(self) -> None:
-        """
-        The _initialize_session function is used to initialize the session object.
-
-        :param self
-        :return: None
-        """
-
-        if self._session is not None:
-            self._session.close()
-
-        self._session = requests.Session()
-
-        if self.auth and self.auth[0] == '__key__':
-            self._session.headers.update(
-                {'key': self.auth[1]}
-            )
-        elif self.auth:
-            self._session.auth = self.auth
-
-    def _request(self, method, path, *args, **kwargs) -> requests.Response:
-        """
-        The _request function is a helper function that makes it easier to make requests to the API.
-        It takes in a method, path, and any other arguments you want to pass into the request.
-        The method argument should be one of 'get', 'post', or 'delete'. The path argument should be
-        the endpoint you are trying to reach (e.g., '/users/me'). Any additional arguments will be passed
-        into the request as-is.
-
-        :param self
-        :param method: Specify the type of request that is being made
-        :param path: Specify the path of the request
-        :return: A response object
-        """
-
-        for attempt in range(2):
-            try:
-                response = getattr(self._session, method)(
-                    f'{self.host}/{path.strip("/")}',
-                    timeout=self._timeout,
-                    *args, **kwargs
-                )
-                response.raise_for_status()
-                return response
-            except requests.exceptions.ConnectionError as e:
-                if attempt == 0:
-                    self._initialize_session()
-                    continue
-                else:
-                    raise e
-
-    @property
-    def dataloaders(self):
-        """
-        Data Loader Endpoint.
-
-        :return: An instance of DataLoaderEndpoint.
-        :rtype: DataLoaderEndpoint
-        """
-
-        return DataLoaderEndpoint(self)
-
-    @property
-    def datasources(self):
-        """
-        Data Source Endpoint.
-
-        :return: An instance of DataSourceEndpoint.
-        :rtype: DataSourceEndpoint
-        """
-
-        return DataSourceEndpoint(self)
-
-    @property
-    def datastreams(self):
-        """
-        Datastream Endpoint.
-
-        :return: An instance of DatastreamEndpoint.
-        :rtype: DatastreamEndpoint
-        """
-
-        return DatastreamEndpoint(self)
-
-    @property
-    def observedproperties(self):
-        """
-        Observed Property Endpoint.
-
-        :return: An instance of ObservedPropertyEndpoint.
-        :rtype: ObservedPropertyEndpoint
-        """
-
-        return ObservedPropertyEndpoint(self)
-
-    @property
-    def processinglevels(self):
-        """
-        Processing Level Endpoint.
-
-        :return: An instance of ProcessingLevelEndpoint.
-        :rtype: ProcessingLevelEndpoint
-        """
-
-        return ProcessingLevelEndpoint(self)
-
-    @property
-    def resultqualifiers(self):
-        """
-        Result Qualifier Endpoint.
-
-        :return: An instance of ResultQualifierEndpoint.
-        :rtype: ResultQualifierEndpoint
-        """
-
-        return ResultQualifierEndpoint(self)
-
-    @property
-    def sensors(self):
-        """
-        Sensor Endpoint.
-
-        :return: An instance of SensorEndpoint.
-        :rtype: SensorEndpoint
-        """
-
-        return SensorEndpoint(self)
-
-    @property
-    def things(self):
-        """
-        Thing Endpoint.
-
-        :return: An instance of ThingEndpoint.
-        :rtype: ThingEndpoint
-        """
-
-        return ThingEndpoint(self)
-
-    @property
-    def units(self):
-        """
-        Unit Endpoint.
-
-        :return: An instance of UnitEndpoint.
-        :rtype: UnitEndpoint
-        """
-
-        return UnitEndpoint(self)

hydroserverpy-0.3.0.dist-info/METADATA

@@ -1,18 +0,0 @@
-Metadata-Version: 2.1
-Name: hydroserverpy
-Version: 0.3.0
-Requires-Python: <4,>=3.9
-License-File: LICENSE
-Requires-Dist: requests >=2
-Requires-Dist: pydantic >=2.6
-Requires-Dist: pandas >=2.2
-Requires-Dist: numpy >=2.0
-Requires-Dist: pyyaml >=5
-Requires-Dist: simplejson >=3
-Requires-Dist: crontab >=1
-Requires-Dist: python-dateutil >=2.8.2
-Requires-Dist: croniter >=2.0.1
-Requires-Dist: country-list >=1.1.0
-Provides-Extra: docs
-Requires-Dist: sphinx-autodoc-typehints ; extra == 'docs'
-

hydroserverpy-0.3.0.dist-info/RECORD

@@ -1,36 +0,0 @@
-hydroserverpy/__init__.py,sha256=oVxU_pSr5RZx4s5UHYYNCrjXQAP5lujlosB2a3qG260,223
-hydroserverpy/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-hydroserverpy/core/service.py,sha256=ch6rwNM8oM3L-9phE474grofCR3QkTQ8AopkMyn9sjo,5339
-hydroserverpy/core/endpoints/__init__.py,sha256=SpN1WLX0R8HOLHBv1cp3VZcIEiKD4BBbgFGQppdA_mw,404
-hydroserverpy/core/endpoints/base.py,sha256=Ay0a8rucNo9x8h1MMMuMaISkBAgc9DK_kouLGtnHPjk,4925
-hydroserverpy/core/endpoints/data_loaders.py,sha256=boUdmn9_9QDJS38nBXwKXYiX_We_rfK1OFjCU8ptQUE,3009
-hydroserverpy/core/endpoints/data_sources.py,sha256=c9hwlFUUY-Ae84TrlB2boLjKIIhN_fzxHSYvPSb9PKA,3007
-hydroserverpy/core/endpoints/datastreams.py,sha256=z8NX21L2qcj07Cotm5sTT3GrNEV2jS0-AjLQDRHeRq8,6899
-hydroserverpy/core/endpoints/observed_properties.py,sha256=7_BtjsCyyGaQ1EMhlQXhWupTs85q7i85LdRLejVUb9o,3309
-hydroserverpy/core/endpoints/processing_levels.py,sha256=pDolo_BqkSufs3w_ykRbsg-93xWME7vYIA6BAwzdT7A,3286
-hydroserverpy/core/endpoints/result_qualifiers.py,sha256=977r3Vf6Y3kkoRcHQwTbQPSCxxeWsJkcDCPhFI30Tss,3301
-hydroserverpy/core/endpoints/sensors.py,sha256=niF6eY8dFdfowqW_dLq9-7CPolWO__lFwElMDJTYtsM,3122
-hydroserverpy/core/endpoints/things.py,sha256=n0nSq2AgJ7zFwAerkTtYlFvc1EzgUfHsu_nNTcVxqr0,8357
-hydroserverpy/core/endpoints/units.py,sha256=UZKizV8ZLMCPZQ0ol5U8UON_MB80uhxL2PUwDbtQLXA,3084
-hydroserverpy/core/schemas/__init__.py,sha256=gUFAim1jcUWAvj0IqpR8UKaCdXT1v11SmFnOzEmcwJM,353
-hydroserverpy/core/schemas/base.py,sha256=k5ctiVXLm5A0TI-Nkz9l3oDGsq16B3yKcQgnZcJVDds,3683
-hydroserverpy/core/schemas/data_loaders.py,sha256=BJv0-IUkgsNisuwyOooUAHaAv1DLCF5SVVnBjpfahYM,2470
-hydroserverpy/core/schemas/data_sources.py,sha256=oearfow10p-JJ5d_3-S2IEJ4039d4SMQlVA0N4dNOH0,8058
-hydroserverpy/core/schemas/datastreams.py,sha256=OEVc7xMVaFSHvLMyunt2g0u6xAfv5xg0fO6Uz8VjOSU,11413
-hydroserverpy/core/schemas/observed_properties.py,sha256=1ibOAYbsf1DQAos68V8KEmvBUoS2WO73dd5MhSWCC90,1161
-hydroserverpy/core/schemas/processing_levels.py,sha256=K4N5by5bfSD3iPcx6Jv1x-xOPxW3_gwhZcEfaqwSDmQ,867
-hydroserverpy/core/schemas/result_qualifiers.py,sha256=ejUMPCDOq3cuq3a6j2uvQNRdVNEVQ1jJAacYv-o9NZI,722
-hydroserverpy/core/schemas/sensors.py,sha256=8nXSEyD1kGAL2Wi76kHvjXNSgh2VFTfMgBkFP8ACsZw,1835
-hydroserverpy/core/schemas/things.py,sha256=Pkr3bIo4VjLML7o53_R2lXwBmx0Z7aoGlvJKC9Diw60,11139
-hydroserverpy/core/schemas/units.py,sha256=EB4HATC-C2RxPC0EpcVN--aQa6nl1O9Lj1jkpXlJ-8Y,826
-hydroserverpy/etl/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-hydroserverpy/etl/exceptions.py,sha256=0UY8YUlNepG0y6FfH36hJyR1bOhwYHSZIdUSSMTg7GA,314
-hydroserverpy/etl/service.py,sha256=g-zp89KK4MDIdcTWQDNKbCg485ByAg0Ui01ooFldxhI,12414
-hydroserverpy/quality/__init__.py,sha256=GGBMkFSXciJLYrbV-NraFrj_mXWCy_GTcy9KKrKXU4c,84
-hydroserverpy/quality/service.py,sha256=3y6hjt1jcRcQSx9xRw37YLFBNCch488MHhn-p5nmR6E,13830
-hydroserverpy-0.3.0.dist-info/LICENSE,sha256=xVqFxDw3QOEJukakL7gQCqIMTQ1dlSCTo6Oc1otNW80,1508
-hydroserverpy-0.3.0.dist-info/METADATA,sha256=8n1ZsmvItJmbNl7EgTtOGE4zr-MqY4xE-H5CUMZ3zgU,488
-hydroserverpy-0.3.0.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
-hydroserverpy-0.3.0.dist-info/top_level.txt,sha256=Zf37hrncXLOYvXhgCrf5mZdeq81G9fShdE2LfYbtb7w,14
-hydroserverpy-0.3.0.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-hydroserverpy-0.3.0.dist-info/RECORD,,