From 84a311f6ab425227d22962d4c7e58bc9a0884ba7 Mon Sep 17 00:00:00 2001 From: Yahya Al-Shamali <42281247+PointlessUsername@users.noreply.github.com> Date: Thu, 18 May 2023 01:55:10 -0600 Subject: [PATCH] updated readme --- README.md | 85 ++++++++++++++++++++++++++++--------------------------- setup.py | 2 +- 2 files changed, 44 insertions(+), 43 deletions(-) diff --git a/README.md b/README.md index 110d4fb..659f47d 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Mecsimcalc 0.0.4 documentation +# Mecsimcalc 0.0.5 documentation This library is designed to provide a set of functions for handling and converting various types of data, such as base64 encoded data, Pandas DataFrames, and Pillow images. @@ -7,9 +7,9 @@ This library is designed to provide a set of functions for handling and converti ## General -
-

decode_file_data

- [Source] +
+

decode_file_data

+ [Source]
```python @@ -45,9 +45,9 @@ data:image/jpeg;base64, ``` -
-

download_text

- [Source] +
+

download_text

+ [Source]
```python @@ -96,9 +96,9 @@ Generates a downloadable text file containing the given text ## Tables/DataFrames -
-

file_to_dataframe

- [Source] +
+

file_to_dataframe

+ [Source]
```python @@ -139,9 +139,9 @@ Converts a file object into a pandas DataFrame 1 d e f ``` -
-

input_to_dataframe

- [Source] +
+

input_to_dataframe

+ [Source]
```python @@ -175,9 +175,9 @@ Converts a base64 encoded file data into a pandas DataFrame 1 d e f ``` -
-

print_dataframe

- [Source] +
+

print_dataframe

+ [Source]
```python @@ -237,9 +237,9 @@ Downloading Table {{ outputs.download }} ``` -
-

table_to_dataframe

- [Source] +
+

table_to_dataframe

+ [Source]
```python @@ -273,42 +273,43 @@ Creates a DataFrame from given columns and headers A B C 0 a b c 1 d e f + ``` -
-

print_table

- [Source] +
+

print_table

+ [Source]
```python -print_table(columns: List[List[str]], column_headers: List[str]): +print_table(rows: List[List[str]], column_headers: List[str]): ``` #### Description: -Creates an HTML table from given columns and headers +Creates an HTML table from given rows and column headers #### Arguments: -| Argument | Type | Description | -| -------------------- | ------------------- | ------------------------------------------------------------------------------ | -| **`columns`** | **List[List[str]]** | List of columns to be converted into a table. Each column is a list of strings | -| **`column_headers`** | **List[str]** | List of column headers | +| Argument | Type | Description | +| -------------------- | ------------------- | --------------------------------------------------------------------------- | +| **`rows`** | **List[List[str]]** | List of rows to be converted into a table. Each column is a list of strings | +| **`column_headers`** | **List[str]** | List of column headers | #### Returns: -| Return Type | Description | -| ----------- | ------------------------------------------- | -| **`str`** | HTML table created from columns and headers | +| Return Type | Description | +| ----------- | ---------------------------------------- | +| **`str`** | HTML table created from rows and headers | #### Example: #### Python Code: ```python ->>> columns = [["a", "b", "c"], ["d", "e", "f"]] +>>> rows = [["a", "b", "c"], ["d", "e", "f"]] >>> column_headers = ["A", "B", "C"] ->>> table = print_table(columns, column_headers) +>>> table = print_table(rows, column_headers) >>> return { "table":table, } @@ -324,9 +325,9 @@ Displaying Table ## Images -
-

input_to_PIL

- [Source] +
+

input_to_PIL

+ [Source]
```python @@ -360,9 +361,9 @@ data:image/jpeg;base64, ``` -
-

print_img

- [Source] +
+

print_img

+ [Source]
```python @@ -428,9 +429,9 @@ Downloading Image {{ outputs.download }} ``` -
-

print_plt

- [Source] +
+

print_plt

+ [Source]
```python diff --git a/setup.py b/setup.py index 76cb57e..9bd7376 100644 --- a/setup.py +++ b/setup.py @@ -7,7 +7,7 @@ with codecs.open(os.path.join(here, "README.md"), encoding="utf-8") as fh: long_description = "\n" + fh.read() -VERSION = "0.0.4" +VERSION = "0.0.5" DESCRIPTION = "Useful functions for MecSimCalc.com" LONG_DESCRIPTION = "Useful functions for MecSimCalc.com"