pyrox-client 0.0.3__tar.gz → 0.0.4__tar.gz

pyrox_client-0.0.4/PKG-INFO

@@ -0,0 +1,30 @@
+Metadata-Version: 2.4
+Name: pyrox-client
+Version: 0.0.4
+Summary: HYROX race data client – retrieve full race results via Python
+Author: Vlad Matei
+License: MIT
+Requires-Python: >=3.9
+Requires-Dist: fastparquet>=2024.5.0
+Requires-Dist: fsspec>=2024.2.0
+Requires-Dist: pandas>=2.2
+Requires-Dist: platformdirs>=4.2.0
+Requires-Dist: requests>=2.31
+Requires-Dist: s3fs>=2024.2.0
+Provides-Extra: duckdb
+Requires-Dist: duckdb>=1.0.0; extra == 'duckdb'
+Description-Content-Type: text/markdown
+
+Package to retrieve Hyrox race data programmatically
+
+At the moment, only 3 endpoints -- examples below
+
+
+
+```commandline
+s6races_info = list_races(season=6)  #  list available races of season 6
+all_races_info = list_races()  #  without passing in a season parameter - see all available races in the data warehouse
+s6races_subset = get_season(season=6, locations=['london', 'hamburg'])  # get a subset of races from a specified season
+london_season6 = get_race(season=6, location="london")   #  get a specific race
+hamburg_season6 = get_race(season=6, location="hamburg", division="open", gender="m")  #  get a specific race, with extra-filtering applied
+```

pyrox_client-0.0.4/README.md

@@ -0,0 +1,13 @@
+Package to retrieve Hyrox race data programmatically
+
+At the moment, only 3 endpoints -- examples below
+
+
+
+```commandline
+s6races_info = list_races(season=6)  #  list available races of season 6
+all_races_info = list_races()  #  without passing in a season parameter - see all available races in the data warehouse
+s6races_subset = get_season(season=6, locations=['london', 'hamburg'])  # get a subset of races from a specified season
+london_season6 = get_race(season=6, location="london")   #  get a specific race
+hamburg_season6 = get_race(season=6, location="hamburg", division="open", gender="m")  #  get a specific race, with extra-filtering applied
+```

{pyrox_client-0.0.3 → pyrox_client-0.0.4}/src/pyrox/__init__.py

@@ -1,6 +1,6 @@
 from .core import get_race, list_races
 from .config import set_bucket, set_manifest_path, get_config
 
-__version__ = "0.0.3"
+__version__ = "0.0.4"
 
 __all__ = ["get_race", "list_races", "set_bucket", "set_manifest_path", "get_config"]

pyrox_client-0.0.3/PKG-INFO

@@ -1,62 +0,0 @@
-Metadata-Version: 2.4
-Name: pyrox-client
-Version: 0.0.3
-Summary: HYROX race data client – retrieve full race results via Python
-Author: Vlad Matei
-License: MIT
-Requires-Python: >=3.9
-Requires-Dist: fastparquet>=2024.5.0
-Requires-Dist: fsspec>=2024.2.0
-Requires-Dist: pandas>=2.2
-Requires-Dist: platformdirs>=4.2.0
-Requires-Dist: requests>=2.31
-Requires-Dist: s3fs>=2024.2.0
-Provides-Extra: duckdb
-Requires-Dist: duckdb>=1.0.0; extra == 'duckdb'
-Description-Content-Type: text/markdown
-
-Package to retrieve Hyrox race data programmatically - data
-\available in a S3 Bucket
-API folder contains the logic for the API
-
-This is now deployed via fly - from the command line, we can do the below useful commands
-
- ```
- fly auth login (required to login and run from CL) 
- fly scale count 0 (0 machines allocated to the app)
- fly machines list  (shows the state of the machine as well - so can now if running or stopped)
- fly volumes list -a pyrox-api-proud-surf-3131 (passing the application name)
- 
- fly deploy (if making new changes locally and wanting to deploythe latest version)
-```
-
-
-Running the API via docker 
-Below mounts the app/api and app/src folders to the image
-So any changes are reflected without having to rebuild the container and run again!
-
-```
-docker run -it --rm -p 8000:8080 \
-  -v "$PWD/api:/app/api" -v "$PWD/src:/app/src" \
-  -e PYROX_BUCKET="s3://hyrox-results" -e AWS_REGION="eu-west-1" \
-  pyrox-api \
-  python -m uvicorn api.app:app --host 0.0.0.0 --port 8080 --reload
-```
-
-Command to build the Docker container (ran from repo root)
-```
-docker build -f api/Dockerfile -t pyrox-api .  
-```
-
-
-The API is used by the client (which is in the src folder) under the pyrox module
-
-The base URL there is the variable that controls what we are pointing our client to (either the deployed FLY api or a Docker container running locally on port 8000)
-
-
-```commandline
-season6races_info = list_races(season=6)
-season6racesdf = get_season(season=6, locations=['london', 'hamburg'])
-london_season6 = get_race(season=6, location="london")
-hamburg_season6 = get_race(season=6, location="hamburg", division="open", gender="m")
-```

pyrox_client-0.0.3/README.md

@@ -1,45 +0,0 @@
-Package to retrieve Hyrox race data programmatically - data
-\available in a S3 Bucket
-API folder contains the logic for the API
-
-This is now deployed via fly - from the command line, we can do the below useful commands
-
- ```
- fly auth login (required to login and run from CL) 
- fly scale count 0 (0 machines allocated to the app)
- fly machines list  (shows the state of the machine as well - so can now if running or stopped)
- fly volumes list -a pyrox-api-proud-surf-3131 (passing the application name)
- 
- fly deploy (if making new changes locally and wanting to deploythe latest version)
-```
-
-
-Running the API via docker 
-Below mounts the app/api and app/src folders to the image
-So any changes are reflected without having to rebuild the container and run again!
-
-```
-docker run -it --rm -p 8000:8080 \
-  -v "$PWD/api:/app/api" -v "$PWD/src:/app/src" \
-  -e PYROX_BUCKET="s3://hyrox-results" -e AWS_REGION="eu-west-1" \
-  pyrox-api \
-  python -m uvicorn api.app:app --host 0.0.0.0 --port 8080 --reload
-```
-
-Command to build the Docker container (ran from repo root)
-```
-docker build -f api/Dockerfile -t pyrox-api .  
-```
-
-
-The API is used by the client (which is in the src folder) under the pyrox module
-
-The base URL there is the variable that controls what we are pointing our client to (either the deployed FLY api or a Docker container running locally on port 8000)
-
-
-```commandline
-season6races_info = list_races(season=6)
-season6racesdf = get_season(season=6, locations=['london', 'hamburg'])
-london_season6 = get_race(season=6, location="london")
-hamburg_season6 = get_race(season=6, location="hamburg", division="open", gender="m")
-```