revnext 0.1.0__tar.gz → 0.1.2__tar.gz

revnext-0.1.2/PKG-INFO

@@ -0,0 +1,126 @@
+Metadata-Version: 2.4
+Name: revnext
+Version: 0.1.2
+Summary: Revolution Next (*.revolutionnext.com.au) report downloads via REST API
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/Luen/RevNext-TUNE/
+Project-URL: Repository, https://github.com/Luen/RevNext-TUNE/
+Keywords: revnext,revolution-next,reports,api
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: requests
+
+# revnext
+
+Download Revolution Next (*.revolutionnext.com.au) reports (Parts Price List, Parts by Bin Location) via REST API using cookies/session.
+
+Install: `pip install revnext`  
+Or from repo root: `pip install -e ./packages/revnext`
+
+## Quick start
+
+You need a cookies file (Chrome export for your RevNext domain). Then call the download functions with your instance URL and download location.
+
+### Download one report with a specific file path
+
+```python
+from pathlib import Path
+from revnext import download_parts_by_bin_report, download_parts_price_list_report
+
+base_url = "https://yoursite.revolutionnext.com.au"
+cookies_path = Path("revnext-cookies.json")
+
+# Parts by Bin Location
+path1 = download_parts_by_bin_report(
+    base_url=base_url,
+    output_path=Path("C:/Reports/parts_by_bin.csv"),
+    cookies_path=cookies_path,
+)
+
+# Parts Price List
+path2 = download_parts_price_list_report(
+    base_url=base_url,
+    output_path=Path("C:/Reports/parts_price_list.csv"),
+    cookies_path=cookies_path,
+)
+```
+
+### Example: download both reports (implement in your project)
+
+Copy this into your project to run both reports in sequence:
+
+```python
+from pathlib import Path
+from typing import Optional
+
+from revnext import download_parts_by_bin_report, download_parts_price_list_report
+
+
+def download_all_reports(
+    cookies_path: Optional[Path | str] = None,
+    output_dir: Optional[Path | str] = None,
+    base_url: Optional[str] = None,
+) -> list[Path]:
+    """Run both reports and save CSVs. Returns the list of paths where files were saved."""
+    output_dir = Path(output_dir) if output_dir is not None else Path.cwd()
+    path1 = download_parts_by_bin_report(
+        cookies_path=cookies_path,
+        output_path=output_dir / "Parts_By_Bin_Location.csv",
+        base_url=base_url,
+    )
+    path2 = download_parts_price_list_report(
+        cookies_path=cookies_path,
+        output_path=output_dir / "Parts_Price_List.csv",
+        base_url=base_url,
+    )
+    return [path1, path2]
+```
+
+### Example: download both reports in parallel (implement in your project)
+
+Copy this into your project to run both reports concurrently (Promise.all-style):
+
+```python
+from concurrent.futures import ThreadPoolExecutor
+from pathlib import Path
+from typing import Optional
+
+from revnext import download_parts_by_bin_report, download_parts_price_list_report
+
+
+def download_all_reports_parallel(
+    cookies_path: Optional[Path | str] = None,
+    output_dir: Optional[Path | str] = None,
+    base_url: Optional[str] = None,
+) -> list[Path]:
+    """Run both reports in parallel. Returns the list of paths where files were saved."""
+    output_dir = Path(output_dir) if output_dir is not None else Path.cwd()
+    path1 = output_dir / "Parts_By_Bin_Location.csv"
+    path2 = output_dir / "Parts_Price_List.csv"
+    with ThreadPoolExecutor(max_workers=2) as executor:
+        f1 = executor.submit(
+            download_parts_by_bin_report,
+            cookies_path=cookies_path,
+            output_path=path1,
+            base_url=base_url,
+        )
+        f2 = executor.submit(
+            download_parts_price_list_report,
+            cookies_path=cookies_path,
+            output_path=path2,
+            base_url=base_url,
+        )
+        return [f1.result(), f2.result()]
+```
+
+### Using environment variables
+
+Set `REVOLUTIONNEXT_URL` and optionally `REVOLUTIONNEXT_COOKIES_PATH`; then you can omit `base_url` and `cookies_path` in code.
+
+See the [main repo README](../README.md) for full configuration options.

revnext-0.1.2/README.md

@@ -0,0 +1,108 @@
+# revnext
+
+Download Revolution Next (*.revolutionnext.com.au) reports (Parts Price List, Parts by Bin Location) via REST API using cookies/session.
+
+Install: `pip install revnext`  
+Or from repo root: `pip install -e ./packages/revnext`
+
+## Quick start
+
+You need a cookies file (Chrome export for your RevNext domain). Then call the download functions with your instance URL and download location.
+
+### Download one report with a specific file path
+
+```python
+from pathlib import Path
+from revnext import download_parts_by_bin_report, download_parts_price_list_report
+
+base_url = "https://yoursite.revolutionnext.com.au"
+cookies_path = Path("revnext-cookies.json")
+
+# Parts by Bin Location
+path1 = download_parts_by_bin_report(
+    base_url=base_url,
+    output_path=Path("C:/Reports/parts_by_bin.csv"),
+    cookies_path=cookies_path,
+)
+
+# Parts Price List
+path2 = download_parts_price_list_report(
+    base_url=base_url,
+    output_path=Path("C:/Reports/parts_price_list.csv"),
+    cookies_path=cookies_path,
+)
+```
+
+### Example: download both reports (implement in your project)
+
+Copy this into your project to run both reports in sequence:
+
+```python
+from pathlib import Path
+from typing import Optional
+
+from revnext import download_parts_by_bin_report, download_parts_price_list_report
+
+
+def download_all_reports(
+    cookies_path: Optional[Path | str] = None,
+    output_dir: Optional[Path | str] = None,
+    base_url: Optional[str] = None,
+) -> list[Path]:
+    """Run both reports and save CSVs. Returns the list of paths where files were saved."""
+    output_dir = Path(output_dir) if output_dir is not None else Path.cwd()
+    path1 = download_parts_by_bin_report(
+        cookies_path=cookies_path,
+        output_path=output_dir / "Parts_By_Bin_Location.csv",
+        base_url=base_url,
+    )
+    path2 = download_parts_price_list_report(
+        cookies_path=cookies_path,
+        output_path=output_dir / "Parts_Price_List.csv",
+        base_url=base_url,
+    )
+    return [path1, path2]
+```
+
+### Example: download both reports in parallel (implement in your project)
+
+Copy this into your project to run both reports concurrently (Promise.all-style):
+
+```python
+from concurrent.futures import ThreadPoolExecutor
+from pathlib import Path
+from typing import Optional
+
+from revnext import download_parts_by_bin_report, download_parts_price_list_report
+
+
+def download_all_reports_parallel(
+    cookies_path: Optional[Path | str] = None,
+    output_dir: Optional[Path | str] = None,
+    base_url: Optional[str] = None,
+) -> list[Path]:
+    """Run both reports in parallel. Returns the list of paths where files were saved."""
+    output_dir = Path(output_dir) if output_dir is not None else Path.cwd()
+    path1 = output_dir / "Parts_By_Bin_Location.csv"
+    path2 = output_dir / "Parts_Price_List.csv"
+    with ThreadPoolExecutor(max_workers=2) as executor:
+        f1 = executor.submit(
+            download_parts_by_bin_report,
+            cookies_path=cookies_path,
+            output_path=path1,
+            base_url=base_url,
+        )
+        f2 = executor.submit(
+            download_parts_price_list_report,
+            cookies_path=cookies_path,
+            output_path=path2,
+            base_url=base_url,
+        )
+        return [f1.result(), f2.result()]
+```
+
+### Using environment variables
+
+Set `REVOLUTIONNEXT_URL` and optionally `REVOLUTIONNEXT_COOKIES_PATH`; then you can omit `base_url` and `cookies_path` in code.
+
+See the [main repo README](../README.md) for full configuration options.

{revnext-0.1.0 → revnext-0.1.2}/pyproject.toml

@@ -1,27 +1,31 @@
-[build-system]
-requires = ["setuptools>=61", "wheel"]
-build-backend = "setuptools.build_meta"
-
-[project]
-name = "revnext"
-version = "0.1.0"
-description = "Revolution Next (*.revolutionnext.com.au) report downloads via REST API"
-readme = "README.md"
-license = "MIT"
-requires-python = ">=3.10"
-keywords = ["revnext", "revolution-next", "reports", "api"]
-classifiers = [
-    "Development Status :: 3 - Alpha",
-    "Intended Audience :: Developers",
-    "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.10",
-    "Programming Language :: Python :: 3.11",
-    "Programming Language :: Python :: 3.12",
-]
-dependencies = [
-    "requests",
-]
-
-[tool.setuptools.packages.find]
-where = ["."]
-include = ["revnext*"]
+[build-system]
+requires = ["setuptools>=61", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "revnext"
+version = "0.1.2"
+description = "Revolution Next (*.revolutionnext.com.au) report downloads via REST API"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.10"
+keywords = ["revnext", "revolution-next", "reports", "api"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+dependencies = [
+    "requests",
+]
+
+[project.urls]
+Homepage = "https://github.com/Luen/RevNext-TUNE/"
+Repository = "https://github.com/Luen/RevNext-TUNE/"
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["revnext*"]

{revnext-0.1.0 → revnext-0.1.2}/revnext/__init__.py

@@ -1,18 +1,16 @@
-"""
-Revolution Next (*.revolutionnext.com.au) report downloads via REST API.
-"""
-
-from revnext.config import RevNextConfig, get_revnext_base_url_from_env
-from revnext.parts_by_bin_report import download_parts_by_bin_report
-from revnext.parts_price_list_report import download_parts_price_list_report
-from revnext.download_all_reports import download_all_reports
-
-__all__ = [
-    "RevNextConfig",
-    "get_revnext_base_url_from_env",
-    "download_parts_by_bin_report",
-    "download_parts_price_list_report",
-    "download_all_reports",
-]
-
-__version__ = "0.1.0"
+"""
+Revolution Next (*.revolutionnext.com.au) report downloads via REST API.
+"""
+
+from revnext.config import RevNextConfig, get_revnext_base_url_from_env
+from revnext.parts_by_bin_report import download_parts_by_bin_report
+from revnext.parts_price_list_report import download_parts_price_list_report
+
+__all__ = [
+    "RevNextConfig",
+    "get_revnext_base_url_from_env",
+    "download_parts_by_bin_report",
+    "download_parts_price_list_report",
+]
+
+__version__ = "0.1.0"