python-pirateweather 1.0.0__py3-none-any.whl

pirateweather/__init__.py

@@ -0,0 +1,5 @@
+"""Initializes the Pirate Weather library."""
+
+# ruff: noqa: F401
+
+from pirateweather.api import load_forecast, manual

pirateweather/api.py

@@ -0,0 +1,78 @@
+"""Fetches data from the Pirate Weather API."""
+
+import threading
+
+import requests
+
+from pirateweather.models import Forecast
+
+
+def load_forecast(
+    key, lat, lng, time=None, units="us", lang="en", lazy=False, callback=None
+):
+    """Build the request url and loads some or all of the needed json depending on lazy is True.
+
+    inLat:  The latitude of the forecast
+    inLong: The longitude of the forecast
+    time:   A datetime.datetime object representing the desired time of
+           the forecast. If no timezone is present, the API assumes local
+           time at the provided latitude and longitude.
+    units:  A string of the preferred units of measurement, "us" id
+            default. also ca,uk,si is available
+    lang:   Return summary properties in the desired language
+    lazy:   Defaults to false.  The function will only request the json
+            data as it is needed. Results in more requests, but
+            probably a faster response time (I haven't checked)
+    """
+
+    if time is None:
+        url = (
+            f"https://api.pirateweather.net/forecast/{key}/{lat},{lng}"
+            f"?units={units}&lang={lang}"
+        )
+    else:
+        url_time = time.replace(
+            microsecond=0
+        ).isoformat()  # API returns 400 for microseconds
+        url = (
+            f"https://timemachine.pirateweather.net/forecast/{key}/{lat},{lng},{url_time}"
+            f"?units={units}&lang={lang}"
+        )
+
+    if lazy is True:
+        baseURL = "{}&exclude={}".format(
+            url,
+            "minutely,currently,hourly," "daily,alerts,flags",
+        )
+    else:
+        baseURL = url
+
+    return manual(baseURL, callback=callback)
+
+
+def manual(requestURL, callback=None):
+    """Manually construct the URL for an API call used by load_forecast OR by users."""
+
+    if callback is None:
+        return get_forecast(requestURL)
+    thread = threading.Thread(target=load_async, args=(requestURL, callback))
+    thread.start()
+    return None
+
+
+def get_forecast(requestURL):
+    """Get the forecast from the Pirate Weather API."""
+
+    pirateweather_reponse = requests.get(requestURL, timeout=60)
+    pirateweather_reponse.raise_for_status()
+
+    json = pirateweather_reponse.json()
+    headers = pirateweather_reponse.headers
+
+    return Forecast(json, pirateweather_reponse, headers)
+
+
+def load_async(url, callback):
+    """Get the forecast from the Pirate Weather API asynchronously."""
+
+    callback(get_forecast(url))

pirateweather/models.py

@@ -0,0 +1,159 @@
+"""Models used in the Pirate Weather library."""
+
+import datetime
+
+import requests
+
+from pirateweather.utils import PropertyUnavailable, UnicodeMixin
+
+
+class Forecast(UnicodeMixin):
+    """Represent the forecast data and provide methods to access weather blocks."""
+
+    def __init__(self, data, response, headers):
+        """Initialize the Forecast with data, HTTP response, and headers."""
+        self.response = response
+        self.http_headers = headers
+        self.json = data
+
+        self._alerts = []
+        for alertJSON in self.json.get("alerts", []):
+            self._alerts.append(Alert(alertJSON))
+
+    def update(self):
+        """Update the forecast data by making a new request to the same URL."""
+        r = requests.get(self.response.url)
+        self.json = r.json()
+        self.response = r
+
+    def currently(self):
+        """Return the current weather data block."""
+        return self._pirateweather_data("currently")
+
+    def minutely(self):
+        """Return the minutely weather data block."""
+        return self._pirateweather_data("minutely")
+
+    def hourly(self):
+        """Return the hourly weather data block."""
+        return self._pirateweather_data("hourly")
+
+    def daily(self):
+        """Return the daily weather data block."""
+        return self._pirateweather_data("daily")
+
+    def offset(self):
+        """Return the time zone offset for the forecast location."""
+        return self.json["offset"]
+
+    def alerts(self):
+        """Return the list of alerts issued for this forecast."""
+        return self._alerts
+
+    def _pirateweather_data(self, key):
+        """Fetch and return specific weather data (currently, minutely, hourly, daily)."""
+        keys = ["minutely", "currently", "hourly", "daily"]
+        try:
+            if key not in self.json:
+                keys.remove(key)
+                url = "{}&exclude={}{}".format(
+                    self.response.url.split("&")[0],
+                    ",".join(keys),
+                    ",alerts,flags",
+                )
+
+                response = requests.get(url).json()
+                self.json[key] = response[key]
+
+            if key == "currently":
+                return PirateWeatherDataPoint(self.json[key])
+            return PirateWeatherDataBlock(self.json[key])
+        except KeyError:
+            if key == "currently":
+                return PirateWeatherDataPoint()
+            return PirateWeatherDataBlock()
+
+
+class PirateWeatherDataBlock(UnicodeMixin):
+    """Represent a block of weather data such as minutely, hourly, or daily summaries."""
+
+    def __init__(self, d=None):
+        """Initialize the data block with summary and icon information."""
+        d = d or {}
+        self.summary = d.get("summary")
+        self.icon = d.get("icon")
+        self.data = [
+            PirateWeatherDataPoint(datapoint) for datapoint in d.get("data", [])
+        ]
+
+    def __unicode__(self):
+        """Return a string representation of the data block."""
+        return (
+            "<PirateWeatherDataBlock instance: "
+            "%s with %d PirateWeatherDataPoints>"
+            % (
+                self.summary,
+                len(self.data),
+            )
+        )
+
+
+class PirateWeatherDataPoint(UnicodeMixin):
+    """Represent a single data point in a weather forecast, such as an hourly or daily data point."""
+
+    def __init__(self, d={}):
+        """Initialize the data point with timestamp and weather information."""
+        self.d = d
+
+        try:
+            self.time = datetime.datetime.fromtimestamp(int(d["time"]))
+            self.utime = d["time"]
+        except KeyError:
+            pass
+
+        try:
+            sr_time = int(d["sunriseTime"])
+            self.sunriseTime = datetime.datetime.fromtimestamp(sr_time)
+        except KeyError:
+            self.sunriseTime = None
+
+        try:
+            ss_time = int(d["sunsetTime"])
+            self.sunsetTime = datetime.datetime.fromtimestamp(ss_time)
+        except KeyError:
+            self.sunsetTime = None
+
+    def __getattr__(self, name):
+        """Return the weather property dynamically or raise PropertyUnavailable if missing."""
+        try:
+            return self.d[name]
+        except KeyError as err:
+            raise PropertyUnavailable(
+                f"Property '{name}' is not valid"
+                " or is not available for this forecast"
+            ) from err
+
+    def __unicode__(self):
+        """Return a string representation of the data point."""
+        return "<PirateWeatherDataPoint instance: " f"{self.summary} at {self.time}>"
+
+
+class Alert(UnicodeMixin):
+    """Represent a weather alert, such as a storm warning or flood alert."""
+
+    def __init__(self, json):
+        """Initialize the alert with the raw JSON data."""
+        self.json = json
+
+    def __getattr__(self, name):
+        """Return the alert property dynamically or raise PropertyUnavailable if missing."""
+        try:
+            return self.json[name]
+        except KeyError as err:
+            raise PropertyUnavailable(
+                f"Property '{name}' is not valid" " or is not available for this alert"
+            ) from err
+
+    def __unicode__(self):
+        """Return a string representation of the alert."""
+        return f"<Alert instance: {self.title} at {self.time}>"

pirateweather/utils.py

@@ -0,0 +1,13 @@
+"""Utilities for the Pirate Weather library."""
+
+
+class UnicodeMixin:
+    """Mixin class to handle defining the proper __str__/__unicode__ methods in Python 3."""
+
+    def __str__(self):
+        """Return the unicode representation of the object for Python 3 compatibility."""
+        return self.__unicode__()
+
+
+class PropertyUnavailable(AttributeError):
+    """Raise when a requested property is unavailable in the forecast data."""

python_pirateweather-1.0.0.dist-info/LICENSE.txt

@@ -0,0 +1,13 @@
+## License (BSD 2-clause)
+
+Copyright (c) 2013, Ze'ev Gilovitz and contributors
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

python_pirateweather-1.0.0.dist-info/METADATA

@@ -0,0 +1,200 @@
+Metadata-Version: 2.1
+Name: python-pirateweather
+Version: 1.0.0
+Summary: A thin Python Wrapper for the Pirate Weather API
+Home-page: https://github.com/cloneofghosts/python-pirate-weather
+Author: cloneofghosts
+License: BSD 2-clause
+Keywords: weather API wrapper pirateweather location
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: requests ==2.32.3
+
+# Pirate Weather Wrapper
+
+
+This is a wrapper for the Pirate Weather API. It allows you to get the weather for any location, now, in the past, or future.
+
+The Basic Use section covers enough to get you going. I suggest also reading the source if you want to know more about how to use the wrapper or what its doing (it's very simple).
+
+
+## Installation
+
+You should use pip to install python-pirateweather.
+
+* To install pip install python-pirateweather
+* To remove pip uninstall python-pirateweather
+
+Simple!
+
+## Requirements
+
+- You need an API key to use it (https://pirateweather.net/en/latest/). Don't worry a key is free.
+
+
+## Basic Use
+
+Although you don't need to know anything about the Pirate Weather API to use this module, their docs are available at https://pirateweather.net/en/latest/.
+
+To use the wrapper:
+
+```python
+	import pirateweather
+
+	api_key = "YOUR API KEY"
+	lat = -31.967819
+	lng = 115.87718
+
+	forecast = pirateweather.load_forecast(api_key, lat, lng)
+```
+
+The ``load_forecast()`` method has a few optional parameters. Providing your API key, a latitude and longitude are the only required parameters.
+
+Use the ``forecast.DataBlockType()`` eg. ``currently()``, ``daily()``, ``hourly()``, ``minutely()`` methods to load the data you are after.
+
+These methods return a DataBlock. Except ``currently()`` which returns a DataPoint.
+
+```python
+	byHour = forecast.hourly()
+	print(byHour.summary)
+	print(byHour.icon)
+```
+
+The .data attributes for each DataBlock is a list of DataPoint objects. This is where all the good data is :)
+
+```python
+	for hourlyData in byHour.data:
+		print(hourlyData.temperature)
+```
+
+
+## Advanced
+
+*function* pirateweather.load_forecast(key, latitude, longitude)
+---------------------------------------------------
+
+This makes an API request and returns a **Forecast** object (see below).
+
+Parameters:
+- **key** - Your API key from https://pirateweather.net/en/latest/.
+- **latitude** - The latitude of the location for the forecast
+- **longitude** - The longitude of the location for the forecast
+- **time** - (optional) A datetime object for the forecast either in the past or future - see How Timezones Work below for the details on how timezones are handled in this library.
+- **lang** - (optional) A string of the desired language. See https://pirateweather.net/en/latest/API/#time-machine-request for supported languages.
+- **units** - (optional) A string of the preferred units of measurement, "us" is the default. "us","ca","uk","si" are also available. See the API Docs (https://pirateweather.net/en/latest/API/#units) for exactly what each unit means.
+- **lazy** - (optional) Defaults to `false`.  If `true` the function will request the json data as it is needed. Results in more requests, but maybe a faster response time.
+- **callback** - (optional) Pass a function to be used as a callback. If used, load_forecast() will use an asynchronous HTTP call and **will not return the forecast object directly**, instead it will be passed to the callback function. Make sure it can accept it.
+
+----------------------------------------------------
+
+
+*function* pirateweather.manual(url)
+----------------------------------------------------
+This function allows manual creation of the URL for the Pirate Weather API request.  This method won't be required often but can be used to take advantage of new or beta features of the API which this wrapper does not support yet. Returns a **Forecast** object (see below).
+
+Parameters:
+- **url** - The URL which the wrapper will attempt build a forecast from.
+- **callback** - (optional) Pass a function to be used as a callback. If used, an asynchronous HTTP call will be used and ``pirateweather.manual`` **will not return the forecast object directly**, instead it will be passed to the callback function. Make sure it can accept it.
+
+----------------------------------------------------
+
+
+*class* pirateweather.models.Forecast
+------------------------------------
+
+The **Forecast** object, it contains both weather data and the HTTP response from Pirate Weather
+
+**Attributes**
+- **response**
+	- The Response object returned from requests request.get() method. See https://requests.readthedocs.org/en/latest/api/#requests.Response
+- **http_headers**
+	- A dictionary of response headers. 'X-Forecast-API-Calls' might be of interest, it contains the number of API calls made by the given API key for the month.
+- **json**
+	- A dictionary containing the json data returned from the API call.
+
+**Methods**
+- **currently()**
+	- Returns a PirateWeatherDataPoint object
+- **minutely()**
+	- Returns a PirateWeatherDataBlock object
+- **hourly()**
+	- Returns a PirateWeatherDataBlock object
+- **daily()**
+	- Returns a PirateWeatherDataBlock object
+- **update()**
+	- Refreshes the forecast data by making a new request.
+
+----------------------------------------------------
+
+
+*class* pirateweather.models.PirateWeatherDataBlock
+---------------------------------------------
+
+Contains data about a forecast over time.
+
+**Attributes** *(descriptions taken from the pirateweather.net website)*
+- **summary**
+	- A human-readable text summary of this data block.
+- **icon**
+	- A machine-readable text summary of this data block.
+- **data**
+	- An array of **PirateWeatherDataPoint** objects (see below), ordered by time, which together describe the weather conditions at the requested location over time.
+
+----------------------------------------------------
+
+
+*class* pirateweather.models.PirateWeatherDataPoint
+---------------------------------------------
+
+Contains data about a forecast at a particular time.
+
+Data points have many attributes, but **not all of them are always available**. Some commonly used ones are:
+
+**Attributes** *(descriptions taken from the pirateweather.net website)*
+-	**summary**
+	- A human-readable text summary of this data block.
+-	**icon**
+	- A machine-readable text summary of this data block.
+-	**time**
+	- The time at which this data point occurs.
+-	**temperature**
+	- (not defined on daily data points): A numerical value representing the temperature at the given time.
+-	**precipProbability**
+	- A numerical value between 0 and 1 (inclusive) representing the probability of precipitation occurring at the given time.
+
+For a full list of PirateWeatherDataPoint attributes and attribute descriptions, take a look at the Pirate Weather data point documentation (https://pirateweather.net/en/latest/API/#data-point)
+
+----------------------------------------------------
+
+
+How Timezones Work
+------------------
+Requests with a naive datetime (no time zone specified) will correspond to the supplied time in the requesting location. If a timezone aware datetime object is supplied, the supplied time will be in the associated timezone.
+
+Returned times eg the time parameter on the currently DataPoint are always in UTC time even if making a request with a timezone. If you want to manually convert to the locations local time, you can use the `offset` and `timezone` attributes of the forecast object.
+
+Typically, would would want to do something like this:
+
+```python
+  # Amsterdam
+  lat  = 52.370235
+  lng  = 4.903549
+  current_time = datetime(2015, 2, 27, 6, 0, 0)
+  forecast = pirateweather.load_forecast(api_key, lat, lng, time=current_time)
+```
+
+Be caerful, things can get confusing when doing something like the below. Given that I'm looking up the weather in Amsterdam (+2) while I'm in Perth, Australia (+8).
+
+```python
+  # Amsterdam
+  lat  = 52.370235
+  lng  = 4.903549
+
+  current_time = datetime.datetime.now()
+
+  forecast = pirateweather.load_forecast(api_key, lat, lng, time=current_time)
+```
+
+The result is actually a request for the weather in the future in Amsterdam (by 6 hours). In addition, since all returned times are in UTC, it will report a time two hours behind the *local* time in Amsterdam.
+
+If you're doing lots of queries in the past/future in different locations, the best approach is to consistently use UTC time. Keep in mind `datetime.datetime.utcnow()` is **still a naive datetime**. To use proper timezone aware datetime objects you will need to use a library like `pytz <http://pytz.sourceforge.net/>`_ 

python_pirateweather-1.0.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+pirateweather/__init__.py,sha256=raRpS-b_ltdjbUjuLU1UEFP9xAWXHKv82cw9BTf6tBo,119
+pirateweather/api.py,sha256=vqGwiquAcUVrMNCqD7018-4b53ZktwXI-bAFlbkx0H8,2467
+pirateweather/models.py,sha256=RsSySdcTzoXoJhzxt5WP1JeeuMgqbzV3kYdx5yWg1Wo,5312
+pirateweather/utils.py,sha256=qiCWsEU0GFEpkZBxaiSGWXn4j6nNMIZpA9ik3sNXWs4,435
+python_pirateweather-1.0.0.dist-info/LICENSE.txt,sha256=oHMuaCnD9D2jpuUXmJRy6U0xSp62bBXcikUxHSbumQU,1336
+python_pirateweather-1.0.0.dist-info/METADATA,sha256=qyfT8qONh0e_OeZT2J-9k39xOtpqRZUeDU9r-gujuDI,8533
+python_pirateweather-1.0.0.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
+python_pirateweather-1.0.0.dist-info/top_level.txt,sha256=EtbXy9nj80X06RItu2tVG0VaMXMeqF0-yns1eRBNLyM,14
+python_pirateweather-1.0.0.dist-info/RECORD,,

python_pirateweather-1.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (75.1.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

python_pirateweather-1.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+pirateweather