csvpredict 0.1.0__py3-none-any.whl

csvpredict/__init__.py

@@ -0,0 +1,35 @@
+"""CSVPredict SDK - Analyze and visualize CSV data."""
+
+from .client.models.color_palette import ColorPalette
+from .client.models.font_family import FontFamily
+from .client.models.language import Language
+from .models import (
+	CorrelationMatrix,
+	InspectBatchResult,
+	InspectResult,
+	OverallStatistics,
+	Statistics,
+	SummaryStatistics,
+)
+from .sdk import CSVPredict, ExcelResult, GraphResult, PowerPointResult
+from .server import display, set_download_context, show, stop_server
+
+__all__ = [
+	"CSVPredict",
+	"GraphResult",
+	"ExcelResult",
+	"PowerPointResult",
+	"InspectResult",
+	"InspectBatchResult",
+	"Statistics",
+	"OverallStatistics",
+	"SummaryStatistics",
+	"CorrelationMatrix",
+	"ColorPalette",
+	"FontFamily",
+	"Language",
+	"show",
+	"display",
+	"set_download_context",
+	"stop_server",
+]

csvpredict/client/__init__.py

@@ -0,0 +1,8 @@
+"""A client library for accessing FastAPI"""
+
+from .client import AuthenticatedClient, Client
+
+__all__ = (
+	"AuthenticatedClient",
+	"Client",
+)

csvpredict/client/api/__init__.py

@@ -0,0 +1 @@
+"""Contains methods for accessing the API"""

csvpredict/client/api/api_v1_generate_analysis_graphs/__init__.py

@@ -0,0 +1 @@
+"""Contains endpoint functions for accessing the API"""

csvpredict/client/api/api_v1_generate_analysis_graphs/endpoint_generate_graphs_api_v1_graphs_post.py

@@ -0,0 +1,248 @@
+from http import HTTPStatus
+from typing import Any
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.body_endpoint_generate_graphs_api_v1_graphs_post import (
+	BodyEndpointGenerateGraphsApiV1GraphsPost,
+)
+from ...models.http_validation_error import HTTPValidationError
+from ...types import Response
+
+
+def _get_kwargs(
+	*,
+	body: BodyEndpointGenerateGraphsApiV1GraphsPost,
+) -> dict[str, Any]:
+	headers: dict[str, Any] = {}
+
+	_kwargs: dict[str, Any] = {
+		"method": "post",
+		"url": "/api/v1/graphs/",
+	}
+
+	_kwargs["files"] = body.to_multipart()
+
+	_kwargs["headers"] = headers
+	return _kwargs
+
+
+def _parse_response(
+	*, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Any | HTTPValidationError | None:
+	if response.status_code == 200:
+		response_200 = response.json()
+		return response_200
+
+	if response.status_code == 422:
+		response_422 = HTTPValidationError.from_dict(response.json())
+
+		return response_422
+
+	if client.raise_on_unexpected_status:
+		raise errors.UnexpectedStatus(response.status_code, response.content)
+	else:
+		return None
+
+
+def _build_response(
+	*, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[Any | HTTPValidationError]:
+	return Response(
+		status_code=HTTPStatus(response.status_code),
+		content=response.content,
+		headers=response.headers,
+		parsed=_parse_response(client=client, response=response),
+	)
+
+
+def sync_detailed(
+	*,
+	client: AuthenticatedClient,
+	body: BodyEndpointGenerateGraphsApiV1GraphsPost,
+) -> Response[Any | HTTPValidationError]:
+	r"""Endpoint Generate Graphs
+
+	 Endpoint to generate and download graphs for a single file as a ZIP.
+
+	Args:
+	        api_key (None): The API key dependency.
+	        request (Request): The FastAPI request object. Needed by slowapi limiter.
+	        file (UploadFile): The data file to generate graphs for.
+	        ist[str] | None | None): The columns to partition the data by.
+	        extension (Literal[\".png\", \".jpg\", \".jpeg\", \".svg\"]): The file extension for
+	                the graphs.
+	        transparent (bool): Whether the graph background should be transparent.
+	        window_size (int): The window size for rolling statistics.
+	        null_values (list[str] | None): List of strings to consider as null values.
+	        dpi (int): The resolution (dots per inch) for the generated graphs.
+	        font (FontFamily): The font family to use in the graphs.
+	        language (Language): The language for graph titles.
+	        palette (ColorPalette | None): The main color palette for the graphs.
+	        extra_palette (list[str] | None): The extra color palette for the graphs.
+
+	Returns:
+	        StreamingResponse: A streaming response containing the ZIP file of graphs.
+
+	Args:
+	    body (BodyEndpointGenerateGraphsApiV1GraphsPost):
+
+	Raises:
+	    errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+	    httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+	Returns:
+	    Response[Any | HTTPValidationError]
+	"""
+
+	kwargs = _get_kwargs(
+		body=body,
+	)
+
+	response = client.get_httpx_client().request(
+		**kwargs,
+	)
+
+	return _build_response(client=client, response=response)
+
+
+def sync(
+	*,
+	client: AuthenticatedClient,
+	body: BodyEndpointGenerateGraphsApiV1GraphsPost,
+) -> Any | HTTPValidationError | None:
+	r"""Endpoint Generate Graphs
+
+	 Endpoint to generate and download graphs for a single file as a ZIP.
+
+	Args:
+	        api_key (None): The API key dependency.
+	        request (Request): The FastAPI request object. Needed by slowapi limiter.
+	        file (UploadFile): The data file to generate graphs for.
+	        ist[str] | None | None): The columns to partition the data by.
+	        extension (Literal[\".png\", \".jpg\", \".jpeg\", \".svg\"]): The file extension for
+	                the graphs.
+	        transparent (bool): Whether the graph background should be transparent.
+	        window_size (int): The window size for rolling statistics.
+	        null_values (list[str] | None): List of strings to consider as null values.
+	        dpi (int): The resolution (dots per inch) for the generated graphs.
+	        font (FontFamily): The font family to use in the graphs.
+	        language (Language): The language for graph titles.
+	        palette (ColorPalette | None): The main color palette for the graphs.
+	        extra_palette (list[str] | None): The extra color palette for the graphs.
+
+	Returns:
+	        StreamingResponse: A streaming response containing the ZIP file of graphs.
+
+	Args:
+	    body (BodyEndpointGenerateGraphsApiV1GraphsPost):
+
+	Raises:
+	    errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+	    httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+	Returns:
+	    Any | HTTPValidationError
+	"""
+
+	return sync_detailed(
+		client=client,
+		body=body,
+	).parsed
+
+
+async def asyncio_detailed(
+	*,
+	client: AuthenticatedClient,
+	body: BodyEndpointGenerateGraphsApiV1GraphsPost,
+) -> Response[Any | HTTPValidationError]:
+	r"""Endpoint Generate Graphs
+
+	 Endpoint to generate and download graphs for a single file as a ZIP.
+
+	Args:
+	        api_key (None): The API key dependency.
+	        request (Request): The FastAPI request object. Needed by slowapi limiter.
+	        file (UploadFile): The data file to generate graphs for.
+	        ist[str] | None | None): The columns to partition the data by.
+	        extension (Literal[\".png\", \".jpg\", \".jpeg\", \".svg\"]): The file extension for
+	                the graphs.
+	        transparent (bool): Whether the graph background should be transparent.
+	        window_size (int): The window size for rolling statistics.
+	        null_values (list[str] | None): List of strings to consider as null values.
+	        dpi (int): The resolution (dots per inch) for the generated graphs.
+	        font (FontFamily): The font family to use in the graphs.
+	        language (Language): The language for graph titles.
+	        palette (ColorPalette | None): The main color palette for the graphs.
+	        extra_palette (list[str] | None): The extra color palette for the graphs.
+
+	Returns:
+	        StreamingResponse: A streaming response containing the ZIP file of graphs.
+
+	Args:
+	    body (BodyEndpointGenerateGraphsApiV1GraphsPost):
+
+	Raises:
+	    errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+	    httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+	Returns:
+	    Response[Any | HTTPValidationError]
+	"""
+
+	kwargs = _get_kwargs(
+		body=body,
+	)
+
+	response = await client.get_async_httpx_client().request(**kwargs)
+
+	return _build_response(client=client, response=response)
+
+
+async def asyncio(
+	*,
+	client: AuthenticatedClient,
+	body: BodyEndpointGenerateGraphsApiV1GraphsPost,
+) -> Any | HTTPValidationError | None:
+	r"""Endpoint Generate Graphs
+
+	 Endpoint to generate and download graphs for a single file as a ZIP.
+
+	Args:
+	        api_key (None): The API key dependency.
+	        request (Request): The FastAPI request object. Needed by slowapi limiter.
+	        file (UploadFile): The data file to generate graphs for.
+	        ist[str] | None | None): The columns to partition the data by.
+	        extension (Literal[\".png\", \".jpg\", \".jpeg\", \".svg\"]): The file extension for
+	                the graphs.
+	        transparent (bool): Whether the graph background should be transparent.
+	        window_size (int): The window size for rolling statistics.
+	        null_values (list[str] | None): List of strings to consider as null values.
+	        dpi (int): The resolution (dots per inch) for the generated graphs.
+	        font (FontFamily): The font family to use in the graphs.
+	        language (Language): The language for graph titles.
+	        palette (ColorPalette | None): The main color palette for the graphs.
+	        extra_palette (list[str] | None): The extra color palette for the graphs.
+
+	Returns:
+	        StreamingResponse: A streaming response containing the ZIP file of graphs.
+
+	Args:
+	    body (BodyEndpointGenerateGraphsApiV1GraphsPost):
+
+	Raises:
+	    errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+	    httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+	Returns:
+	    Any | HTTPValidationError
+	"""
+
+	return (
+		await asyncio_detailed(
+			client=client,
+			body=body,
+		)
+	).parsed

csvpredict/client/api/api_v1_generate_analysis_graphs/endpoint_generate_graphs_batch_api_v1_graphs_batch_post.py

@@ -0,0 +1,236 @@
+from http import HTTPStatus
+from typing import Any
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.body_endpoint_generate_graphs_batch_api_v1_graphs_batch_post import (
+	BodyEndpointGenerateGraphsBatchApiV1GraphsBatchPost,
+)
+from ...models.http_validation_error import HTTPValidationError
+from ...types import Response
+
+
+def _get_kwargs(
+	*,
+	body: BodyEndpointGenerateGraphsBatchApiV1GraphsBatchPost,
+) -> dict[str, Any]:
+	headers: dict[str, Any] = {}
+
+	_kwargs: dict[str, Any] = {
+		"method": "post",
+		"url": "/api/v1/graphs/batch",
+	}
+
+	_kwargs["files"] = body.to_multipart()
+
+	_kwargs["headers"] = headers
+	return _kwargs
+
+
+def _parse_response(
+	*, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Any | HTTPValidationError | None:
+	if response.status_code == 200:
+		response_200 = response.json()
+		return response_200
+
+	if response.status_code == 422:
+		response_422 = HTTPValidationError.from_dict(response.json())
+
+		return response_422
+
+	if client.raise_on_unexpected_status:
+		raise errors.UnexpectedStatus(response.status_code, response.content)
+	else:
+		return None
+
+
+def _build_response(
+	*, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[Any | HTTPValidationError]:
+	return Response(
+		status_code=HTTPStatus(response.status_code),
+		content=response.content,
+		headers=response.headers,
+		parsed=_parse_response(client=client, response=response),
+	)
+
+
+def sync_detailed(
+	*,
+	client: AuthenticatedClient,
+	body: BodyEndpointGenerateGraphsBatchApiV1GraphsBatchPost,
+) -> Response[Any | HTTPValidationError]:
+	r"""Endpoint Generate Graphs Batch
+
+	 Endpoint to generate and download graphs for multiple files as a ZIP.
+
+	Args:
+	        api_key (None): The API key dependency.
+	        request (Request): The FastAPI request object. Needed by slowapi limiter.
+	        files (list[UploadFile]): The data files to generate graphs for.
+	        ist[str] | None | None): The columns to partition the data by.
+	        extension (Literal[\".png\", \".jpg\", \".jpeg\", \".svg\"]): The file extension for
+	                the graphs.
+	        transparent (bool): Whether the graph background should be transparent.
+	        window_size (int): The window size for rolling statistics.
+	        null_values (list[str] | None): List of strings to consider as null values.
+	        font (FontFamily): The font family to use in the graphs.
+	        language (Language): The language for graph titles.
+
+	Returns:
+	        StreamingResponse: A streaming response containing the ZIP file of graphs.
+
+	Args:
+	    body (BodyEndpointGenerateGraphsBatchApiV1GraphsBatchPost):
+
+	Raises:
+	    errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+	    httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+	Returns:
+	    Response[Any | HTTPValidationError]
+	"""
+
+	kwargs = _get_kwargs(
+		body=body,
+	)
+
+	response = client.get_httpx_client().request(
+		**kwargs,
+	)
+
+	return _build_response(client=client, response=response)
+
+
+def sync(
+	*,
+	client: AuthenticatedClient,
+	body: BodyEndpointGenerateGraphsBatchApiV1GraphsBatchPost,
+) -> Any | HTTPValidationError | None:
+	r"""Endpoint Generate Graphs Batch
+
+	 Endpoint to generate and download graphs for multiple files as a ZIP.
+
+	Args:
+	        api_key (None): The API key dependency.
+	        request (Request): The FastAPI request object. Needed by slowapi limiter.
+	        files (list[UploadFile]): The data files to generate graphs for.
+	        ist[str] | None | None): The columns to partition the data by.
+	        extension (Literal[\".png\", \".jpg\", \".jpeg\", \".svg\"]): The file extension for
+	                the graphs.
+	        transparent (bool): Whether the graph background should be transparent.
+	        window_size (int): The window size for rolling statistics.
+	        null_values (list[str] | None): List of strings to consider as null values.
+	        font (FontFamily): The font family to use in the graphs.
+	        language (Language): The language for graph titles.
+
+	Returns:
+	        StreamingResponse: A streaming response containing the ZIP file of graphs.
+
+	Args:
+	    body (BodyEndpointGenerateGraphsBatchApiV1GraphsBatchPost):
+
+	Raises:
+	    errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+	    httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+	Returns:
+	    Any | HTTPValidationError
+	"""
+
+	return sync_detailed(
+		client=client,
+		body=body,
+	).parsed
+
+
+async def asyncio_detailed(
+	*,
+	client: AuthenticatedClient,
+	body: BodyEndpointGenerateGraphsBatchApiV1GraphsBatchPost,
+) -> Response[Any | HTTPValidationError]:
+	r"""Endpoint Generate Graphs Batch
+
+	 Endpoint to generate and download graphs for multiple files as a ZIP.
+
+	Args:
+	        api_key (None): The API key dependency.
+	        request (Request): The FastAPI request object. Needed by slowapi limiter.
+	        files (list[UploadFile]): The data files to generate graphs for.
+	        ist[str] | None | None): The columns to partition the data by.
+	        extension (Literal[\".png\", \".jpg\", \".jpeg\", \".svg\"]): The file extension for
+	                the graphs.
+	        transparent (bool): Whether the graph background should be transparent.
+	        window_size (int): The window size for rolling statistics.
+	        null_values (list[str] | None): List of strings to consider as null values.
+	        font (FontFamily): The font family to use in the graphs.
+	        language (Language): The language for graph titles.
+
+	Returns:
+	        StreamingResponse: A streaming response containing the ZIP file of graphs.
+
+	Args:
+	    body (BodyEndpointGenerateGraphsBatchApiV1GraphsBatchPost):
+
+	Raises:
+	    errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+	    httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+	Returns:
+	    Response[Any | HTTPValidationError]
+	"""
+
+	kwargs = _get_kwargs(
+		body=body,
+	)
+
+	response = await client.get_async_httpx_client().request(**kwargs)
+
+	return _build_response(client=client, response=response)
+
+
+async def asyncio(
+	*,
+	client: AuthenticatedClient,
+	body: BodyEndpointGenerateGraphsBatchApiV1GraphsBatchPost,
+) -> Any | HTTPValidationError | None:
+	r"""Endpoint Generate Graphs Batch
+
+	 Endpoint to generate and download graphs for multiple files as a ZIP.
+
+	Args:
+	        api_key (None): The API key dependency.
+	        request (Request): The FastAPI request object. Needed by slowapi limiter.
+	        files (list[UploadFile]): The data files to generate graphs for.
+	        ist[str] | None | None): The columns to partition the data by.
+	        extension (Literal[\".png\", \".jpg\", \".jpeg\", \".svg\"]): The file extension for
+	                the graphs.
+	        transparent (bool): Whether the graph background should be transparent.
+	        window_size (int): The window size for rolling statistics.
+	        null_values (list[str] | None): List of strings to consider as null values.
+	        font (FontFamily): The font family to use in the graphs.
+	        language (Language): The language for graph titles.
+
+	Returns:
+	        StreamingResponse: A streaming response containing the ZIP file of graphs.
+
+	Args:
+	    body (BodyEndpointGenerateGraphsBatchApiV1GraphsBatchPost):
+
+	Raises:
+	    errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+	    httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+	Returns:
+	    Any | HTTPValidationError
+	"""
+
+	return (
+		await asyncio_detailed(
+			client=client,
+			body=body,
+		)
+	).parsed

csvpredict/client/api/api_v1_generate_excel_files/__init__.py

@@ -0,0 +1 @@
+"""Contains endpoint functions for accessing the API"""