pyRestarters 0.0.2__tar.gz → 0.0.5__tar.gz

{pyrestarters-0.0.2 → pyrestarters-0.0.5}/.github/workflows/action.yaml

@@ -24,9 +24,9 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - name: Set up Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: "3.12"
 
@@ -56,9 +56,9 @@ jobs:
   mypy:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - name: Set up Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: "3.12"
 
@@ -81,10 +81,10 @@ jobs:
         python-version: [ "3.10", "3.11", "3.12", "3.13", "3.14" ]
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python-version }}
 
@@ -107,10 +107,10 @@ jobs:
         python-version: [ "3.10", "3.11", "3.12", "3.13", "3.14" ]
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python-version }}
 
@@ -131,9 +131,9 @@ jobs:
     name: Build source distribution
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
 
-      - uses: actions/setup-python@v5
+      - uses: actions/setup-python@v6
         name: Install Python
         with:
           python-version: "3.12"

pyrestarters-0.0.5/Examples/map_events_this_month.py

@@ -0,0 +1,91 @@
+"""
+An example of using pyRestarters to map all the events due in the UK this month
+"""
+import datetime
+from itertools import chain
+
+import geopandas as gpd
+import matplotlib
+matplotlib.use("TkAgg")
+import matplotlib.pyplot as plt
+from shapely.geometry import Point
+
+from pyRestarters import Groups, Group
+
+from datetime import datetime, timedelta
+
+now = datetime.now()
+
+# Start of month
+start_of_month = now.replace(day=1, hour=0, minute=0, second=0, microsecond=0)
+
+# Start of next month
+if now.month == 12:
+    start_of_next_month = now.replace(
+        year=now.year + 1,
+        month=1,
+        day=1,
+        hour=0,
+        minute=0,
+        second=0,
+        microsecond=0,
+    )
+else:
+    start_of_next_month = now.replace(
+        month=now.month + 1,
+        day=1,
+        hour=0,
+        minute=0,
+        second=0,
+        microsecond=0,
+    )
+
+# End of month (last microsecond before next month)
+end_of_month = start_of_next_month - timedelta(microseconds=1)
+
+if __name__ == "__main__":
+
+    # plot a map of the UK
+    url = "https://raw.githubusercontent.com/johan/world.geo.json/master/countries.geo.json"
+    world = gpd.read_file(url)
+    uk = world[world["name"] == "United Kingdom"]
+    fig, ax = plt.subplots(figsize=(6, 8))
+    uk.plot(
+        ax=ax,
+        edgecolor="black",
+        facecolor="none",
+        linewidth=1
+    )
+    ax.set_title("Locations of Repair Cafe Events this Month")
+    ax.set_axis_off()
+    plt.show()
+
+    # go through all the groups in the restarters.net data and find:
+    # UK groups - tag == 5
+    # Events this month for those UK groups
+    restarters_groups = Groups()
+
+    # function to filter if a group has the UK tag
+    tags = restarters_groups.group_tags
+    def is_uk_group(group: Group) -> bool:
+        tags = group.tags
+        for tag in tags:
+            if tag.id == 5:
+                return True
+        return False
+
+    # The filtering takes the full list groups, find all the UK groups and then chains together
+    # the events before filtering based on this month
+    uk_groups = filter(is_uk_group, restarters_groups)
+    events_this_month = chain.from_iterable(group.events_in_daterange(start=start_of_month, end=end_of_month).values() for group in uk_groups)
+
+    gdf_points = gpd.GeoDataFrame(
+        geometry=[Point(event.coordinates.longitude, event.coordinates.latitude) for event in events_this_month],
+        crs="EPSG:4326"  # WGS84 lon/lat
+    )
+
+    gdf_points.plot(
+        ax=ax,
+        color="green",
+        markersize=2
+    )

pyrestarters-0.0.5/Examples/solent_repair_and_reuse_stats.py

@@ -0,0 +1,58 @@
+"""
+An example of using pyRestarters plot the cumulative statistics for multiple repair groups
+"""
+from dataclasses import dataclass, asdict
+import datetime
+from collections.abc import Iterator
+
+import pandas as pd
+import matplotlib.pyplot as plt
+
+from pyRestarters import Groups
+from pyRestarters.data_model import Statistics
+
+@dataclass
+class EventSummary(Statistics):
+    group: str
+    date: datetime.date
+
+
+if __name__ == '__main__':
+    restarters_groups = Groups()
+    rcg = restarters_groups.group_by_name('Repair Café Gosport')
+    rcp = restarters_groups.group_by_name('Repair Cafe Portchester')
+    rct = restarters_groups.group_by_name('Repair Café Titchfield')
+
+    def event_summarys() -> Iterator[EventSummary]:
+        for group in [rcg,rcp,rct]:
+            for event in group.past_events.values():
+                yield EventSummary(group=group.name,
+                                   date=event.start.date(),
+                                   **asdict(event.statistics))
+
+    srr_event_summary = list(event_summarys())
+    srr_event_summary_df = pd.DataFrame(srr_event_summary)
+
+    fig, all_ax = plt.subplots(figsize=(12, 6), nrows=1, ncols=3)
+    for ax, key, y_label in zip(all_ax,
+                  ["fixed_devices", "co2_total", "waste_total"],
+                  ["Cumulative Items Fixed",
+                   "Cumulative CO2 Emissions Prevented",
+                   "Cumulative Waste Emissions Prevented"]):
+        # Create one column per repair cafe
+        pivot = (
+            srr_event_summary_df.pivot(index="date", columns="group", values=key)
+            .fillna(0)
+            .sort_index()
+        )
+        # Calculate cumulative totals
+        cumulative = pivot.cumsum()
+        cumulative.plot.area(ax=ax)
+        ax.set_xlabel("Date")
+        ax.set_ylabel(y_label)
+        ax.legend(title="Repair Cafe")
+
+    plt.tight_layout()
+    plt.suptitle('KPIs for Solent Repair and Reuse')
+    plt.show()
+

{pyrestarters-0.0.2/src/pyRestarters.egg-info → pyrestarters-0.0.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyRestarters
-Version: 0.0.2
+Version: 0.0.5
 Summary: Pythonic wrapper for the restarters.net API
 Author: Keith Brady
 License:              GNU LESSER GENERAL PUBLIC LICENSE
@@ -190,6 +190,7 @@ Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: requests
+Requires-Dist: typing-extensions; python_version < "3.11"
 Provides-Extra: dev
 Requires-Dist: mypy; extra == "dev"
 Requires-Dist: pylint; extra == "dev"
@@ -210,11 +211,48 @@ Python Wrappers for the restarters.net API
 ## Restarters.net
 [restarters.net](https://restarters.net/) is a website widely used within the Repair Community.
 
-### API
-The [API documentation](https://restarters.net/apiv2/documentation) describes the REST API which
-is wrapped by this package
+### Restarters API
+The [API documentation](https://restarters.net/apiv2/documentation) describes the REST API which is wrapped by this package
+
+## Usage
+
+Currently this package supports reading data from the [restarters.net](https://restarters.net/) website which 
+does not require an API key. The APIs to modify or delete data are not currently supported.
+
 
 ## Getting Started
 
+### Installation
+
+1. Install a recent version of Python 3
+2. Install `pyRestarters`
+   ```console
+   python3 -m pip install pyRestarters
+   ```
+   
+### Demo
+
+The date for the next Repair Cafe Gosport Event
+
+```python
+restarters_groups = Groups()
+rcg = restarters_groups.group_by_name('Repair Café Gosport')
+next_rcg_event = rcg.next_event
+print(f'The next Repair Café Gosport is {next_rcg_event.start:%d %b %Y}')
+```
+
+This will print a string as follows, the date will change if you rerun it
+```
+The next Repair Café Gosport is 14 Feb 2026
+```
+
+
+
+
+
+
+
+
+
 
 

pyrestarters-0.0.5/README.md

@@ -0,0 +1,51 @@
+# PyRestarters
+Python Wrappers for the restarters.net API
+
+## Restarters.net
+[restarters.net](https://restarters.net/) is a website widely used within the Repair Community.
+
+### Restarters API
+The [API documentation](https://restarters.net/apiv2/documentation) describes the REST API which is wrapped by this package
+
+## Usage
+
+Currently this package supports reading data from the [restarters.net](https://restarters.net/) website which 
+does not require an API key. The APIs to modify or delete data are not currently supported.
+
+
+## Getting Started
+
+### Installation
+
+1. Install a recent version of Python 3
+2. Install `pyRestarters`
+   ```console
+   python3 -m pip install pyRestarters
+   ```
+   
+### Demo
+
+The date for the next Repair Cafe Gosport Event
+
+```python
+restarters_groups = Groups()
+rcg = restarters_groups.group_by_name('Repair Café Gosport')
+next_rcg_event = rcg.next_event
+print(f'The next Repair Café Gosport is {next_rcg_event.start:%d %b %Y}')
+```
+
+This will print a string as follows, the date will change if you rerun it
+```
+The next Repair Café Gosport is 14 Feb 2026
+```
+
+
+
+
+
+
+
+
+
+
+

{pyrestarters-0.0.2 → pyrestarters-0.0.5}/pyproject.toml

@@ -5,10 +5,10 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "pyRestarters"
 dynamic = ["version"]
-# Callable is broken in python 3.9.0 and 3.9.1 so these need to be excluded
 requires-python = ">=3.10"
 dependencies = [
     "requests",
+    "typing-extensions;python_version<'3.11'",
 ]
 
 authors = [

{pyrestarters-0.0.2 → pyrestarters-0.0.5}/src/pyRestarters/__about__.py

@@ -17,4 +17,4 @@ along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
 Variables that describes the Package
 """
-__version__ = "0.0.2"
+__version__ = "0.0.5"

{pyrestarters-0.0.2 → pyrestarters-0.0.5}/src/pyRestarters/__init__.py

@@ -16,8 +16,8 @@ You should have received a copy of the GNU Lesser General Public License
 along with this program.  If not, see <https://www.gnu.org/licenses/>.
 """
 # pylint:disable=invalid-name
-from .groups import Groups
-from .groups import Group
-from .events import Event
-from .networks import Networks
-from .networks import Network
+from .data_model import Groups
+from .data_model import Group
+from .data_model import Event
+from .data_model import Networks
+from .data_model import Network