Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
    Links to: zenodo.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (10.7%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

Basic Info
  • Host: GitHub
  • Owner: boscosylvester-john
  • License: mit
  • Language: Python
  • Default Branch: main
  • Size: 113 KB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 2
Created almost 4 years ago · Last pushed over 3 years ago
Metadata Files
Readme Contributing License Code of conduct Citation

README.md

PYTHON CSV SUMMARIZER

This is a requirement for CSC510 Software Engineering HW2,HW3,HW4,HW5 for Group 10

DOI GitHub code size in bytes GitHub commit activity Python CI GitHub top language GitHub Workflow Status (event) GitHub contributors GitHub issues GitHub pull requests GitHub last commit License: MIT

GitHub forks

Goal

Implement the functionalities of this Lua code in Python. Basically this code will read and help store CSV data in an appropriate format. It also summarizes the data column wise and displays a few statistics.

DataTypes

  • Sym
    These are variable names that start with a lower case letter
  • Num
    These are variable names that start with an upper case letter

Classes

  • Num
  • Sym
  • Data
  • Cols
  • Row

Functionality

  • Read CSV
    A csv function that reads each line of a text file, divides on some operator (e.g. comma), removes leading and trailing white space, then coerces the cells to ints, floats, booleans or (failing the rest) to strings.
  • CLI
    It can update the predefined settings to a custom value
  • Help
    Display the option for the CLI functioanlity using -h option
  • Generate Summary
    • For Sym datatype-
    • div = entropy = for symbols occurring at probability p1,p2,... then entropy defined by ∑ -pi * log2(pi).
    • mid = mode which is the most common symbol
    • For Num datatype-
    • div = standard deviation = sort numbers, find 90th, 10th percentile, return (90th-10th)/2.56
    • mid = median of all the numbers

Getting Started

Installation

  • Install python 3.10.7 from here.
  • Create working directory named PythonSummarizer_ bash $ mkdir Python_Summarizer
  • Clone this repository from here or use bash $ git clone https://github.com/boscosylvester-john/se_hw_LuaToPython
  • Install all the requirements using bash $ cd Python_Summarizer $ pip install -r requirements.txt

Running Tests

  • Test all the test files using bash $ cd Python_Summarizer/tests $ python __init__.py
  • Generate the coverage reports bash $ cd Python_Summarizer/tests $ coverage run __init__.py

Coverage Reports

Module statements missing excluded coverage
src\Cols.py 22 1 0 95%
src\Data.py 36 4 0 89%
src\Num.py 37 0 0 100%
src\Row.py 6 0 0 100%
src\Sym.py 28 0 0 100%
src\Utils.py 90 18 0 80%
tests\__init__.py 6 0 0 100%
tests\test_cases.py 56 1 0 98%
tests\test_engine.py 55 11 0 80%
Total 336 35 0 90%

The basic mathemtical operations that this repo does are-

  • Addition
  • Subtraction
  • Multiplication
  • Division

Languages and Tools used

  • Python
  • Github Desktop
  • Git Bash
  • VS Code
  • Codecov

License

License: MIT

License Guidelines

Contribute

Please have a look at the guidelines before contributing.

Authors

Owner

  • Login: boscosylvester-john
  • Kind: user

Citation (CITATION.cff)

cff-version: 1.0.0
message: "If you use this software, please cite it as below."
title: Lua to Python
abstract: This is a command line based project.
authors:
  - family-names: "Chittilapilly"
    given-names: "Boscosylvester John"
  - family-names: "Naik"
    given-names: "Shlok"
  - family-names: "Kini"
    given-names: "Tushar"
  - family-names: "Kamath"
    given-names: "Prasad Vithal"
  - family-names: "Banerji"
    given-names: "Ankur"
version: 1.0.0
doi: 10.5281/zenodo.7052211
date-released: 2022-09-05
url: "https://github.com/boscosylvester-john/se_hw_LuaToPython"

GitHub Events

Total
Last Year