Added new command 'summary'

[shashigharti]

• Added new command named 'summary'.
• Added to_summary function to ReportTask.
• Added tests for both 'summary' command and 'to_summary' function.
• Reorganized the commonly used function to helpers.

• fixes Add default frictionless CLI command #1095

• Shall I also update the documentation here

• https://framework.frictionlessdata.io/docs/guides/validation-guide/#validation-errors to add "to_summary" info.

[shashigharti]

The output looks like this:
summary data/countries.csv

For to_summary

for task in report.tasks:
    summary = task.to_summary()
    print("# Describe \n")
    print(summary['describe'])
    print("\n# Extract \n")
    print(summary['extract'])
    print("\n# Validate \n")
    print(task.valid)
    print("\n# Summary \n")
    print(summary['validate']['summary'])
    print("\n# Errors \n")
    print(summary['validate']['errors'])

# Describe 

+-------------+---------+------------+
| name        | type    | required   |
+=============+=========+============+
| id          | integer |            |
+-------------+---------+------------+
| neighbor_id | string  |            |
+-------------+---------+------------+
| name        | string  |            |
+-------------+---------+------------+
| population  | string  |            |
+-------------+---------+------------+

# Extract 

+----+-------------+-----------+------------+
| id | neighbor_id | name      | population |
+====+=============+===========+============+
|  1 | 'Ireland'   | 'Britain' | '67'       |
+----+-------------+-----------+------------+
|  2 | '3'         | 'France'  | 'n/a'      |
+----+-------------+-----------+------------+
|  3 | '22'        | 'Germany' | '83'       |
+----+-------------+-----------+------------+
|  4 | None        | 'Italy'   | '60'       |
+----+-------------+-----------+------------+
|  5 | None        | None      | None       |
+----+-------------+-----------+------------+


# Validate 

False

# Summary 

+-----------------------------+-------------------------------------------------------------+
| Description                 | Size/Name/Count                                             |
+=============================+=============================================================+
| File name                   | /home/shashi/python/okfn/frictionless-py/data/countries.csv |
+-----------------------------+-------------------------------------------------------------+
| File size (bytes)           | 143                                                         |
+-----------------------------+-------------------------------------------------------------+
| Total Time Taken (sec)      | 0.007                                                       |
+-----------------------------+-------------------------------------------------------------+
| Total Errors                | 4                                                           |
+-----------------------------+-------------------------------------------------------------+
| Extra Cell (extra-cell)     | 1                                                           |
+-----------------------------+-------------------------------------------------------------+
| Missing Cell (missing-cell) | 3                                                           |
+-----------------------------+-------------------------------------------------------------+

# Errors 

+-------+---------+------------+----------------------------------------------------+
|   row |   field | code       | message                                            |
+=======+=========+============+====================================================+
|     4 |       5 | extra-cell | Row at position "4" has an extra value in field at |
|       |         |            | position "5"                                       |
+-------+---------+------------+----------------------------------------------------+
|     7 |       2 | missing-   | Row at position "7" has a missing cell in field    |
|       |         | cell       | "neighbor_id" at position "2"                      |
+-------+---------+------------+----------------------------------------------------+
|     7 |       3 | missing-   | Row at position "7" has a missing cell in field    |
|       |         | cell       | "name" at position "3"                             |
+-------+---------+------------+----------------------------------------------------+
|     7 |       4 | missing-   | Row at position "7" has a missing cell in field    |
|       |         | cell       | "population" at position "4"                       |
+-------+---------+------------+----------------------------------------------------+

[shashigharti]

@roll thank you again!. I have revised the code and put in in the relevant module as you have suggested. And also changed/added tests.

I did not add to_summary function to resource because there is already a function to_view() and I used it to display the data.

I am not sure if tests > resource > validate >test_general is the right place to add the test for schema.to_summay?

[roll]

Great!

I've added a minor comment.

Also, answering your test question -- if it's a report method tests should be in tests/report, schema method test should be in tests/schema etc

[shashigharti]

Thank you @roll , I have made the changes and it is ready for the review. I also placed _wrap_text_to_colwidths function in report.py file and replaced the validate report table display in validate.py command to report.to_summary().

e936c42#diff-ca29842cf90a4bca29af564ebbb9936fce52dfb7d085a7dfe10d58124c991c65R218

what do you think of it?

[shashigharti]

Thank you @roll . I have made the changes. I have also removed the test (that I had added) that were not very related to the changes.

[roll]

Great!