autose-hw1-lua

This project translates a Lua application to Python application complete with CI/CD pipeline and demonstrates Test-Driven development.

https://github.com/amisha-w/autose-hw1-lua

Science Score: 67.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
    Found 3 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.8%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

This project translates a Lua application to Python application complete with CI/CD pipeline and demonstrates Test-Driven development.

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

README.md

# `Lua to Python - AutoSE HW1` ![license](https://img.shields.io/github/license/amisha-w/AutoSE-HW1-Lua) [![language](https://img.shields.io/github/languages/top/amisha-w/AutoSE-HW1-Lua)](https://github.com/amisha-w/AutoSE-HW1-Lua/search?l=python) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7567006.svg)](https://doi.org/10.5281/zenodo.7567006)
[![Unit Tests](https://img.shields.io/github/actions/workflow/status/amisha-w/AutoSE-HW1-Lua/tests.yml?label=Unit%20Tests)](https://github.com/amisha-w/AutoSE-HW1-Lua/actions/workflows/tests.yml) [![codecov](https://codecov.io/gh/amisha-w/AutoSE-HW1-Lua/branch/main/graph/badge.svg?token=)](https://codecov.io/gh/amisha-w/AutoSE-HW1-Lua)
[![documentation](https://github.com/amisha-w/AutoSE-HW1-Lua/actions/workflows/pdoc.yml/badge.svg)](https://github.com/amisha-w/AutoSE-HW1-Lua/actions/workflows/pdoc.yml) [![Commits](https://img.shields.io/github/commit-activity/w/amisha-w/AutoSE-HW1-Lua)](https://github.com/amisha-w/AutoSE-HW1-Lua/graphs/commit-activity) ![Repo Size](https://img.shields.io/github/repo-size/amisha-w/AutoSE-HW1-Lua) ![Open Issues](https://img.shields.io/github/issues/amisha-w/AutoSE-HW1-Lua) [![Closed issues](https://img.shields.io/github/issues-closed-raw/amisha-w/AutoSE-HW1-Lua)](https://github.com/amisha-w/AutoSE-HW1-Lua/issues?q=is%3Aissue+is%3Aclosed) ![Contributors](https://img.shields.io/github/contributors/amisha-w/AutoSE-HW1-Lua?color=cyan) ![PR](https://img.shields.io/github/issues-pr/amisha-w/AutoSE-HW1-Lua?color=red) ![PR Closed](https://img.shields.io/github/issues-pr-closed-raw/amisha-w/AutoSE-HW1-lua?color=red) [![Pylint](https://img.shields.io/github/actions/workflow/status/amisha-w/AutoSE-HW1-Lua/pylint.yml?label=Pylint)](https://github.com/amisha-w/AutoSE-HW1-Lua/actions/workflows/pylint.yml) [![Python Style Checker](https://img.shields.io/github/actions/workflow/status/amisha-w/AutoSE-HW1-Lua/style_checker.yml?label=Style%20Checker)](https://github.com/amisha-w/AutoSE-HW1-Lua/actions/workflows/style_checker.yml) ![GitHub Release Date](https://img.shields.io/github/release-date/amisha-w/AutoSE-HW1-Lua)

This project translates a Lua application to Python application complete with CI/CD pipeline and demonstrates Test-Driven development. It is a homework repository for CSC 591 course.

Features

| Function |Description | | ------------- |:-------------:| | Hw1 Main | Parses the helper string and csv file. | | Num | Class to calculate mean and standard deviation for numeric values. | | Sym | Class to calculate mode and frequency of symbolic values. |

Installation Guide

To run this codebase you just need Python in your System.

You can check if Python is installed in your system by using cmd - "python --version"

Guide for python installation based on the OS - https://www.python.org/downloads/

Code of Conduct

The rules listed below are to be followed by the ones who will be contributing to the code in the repository:

  • It is recommended to take a review of your peer or teammate before mergin any PR or commit.

  • It is recommended to create branches and start the changes in that branch and also delete the branch after commiting the code to avoid stale branches.

Wish to contribute?

  • Please refer the file CONTRIBUTING.md in the repository that guides new contributors on how they can help improve LuaToPython
  • This file is for:
    • Project Owners - Initiaters and maintainers of the file.
    • Project contributors - People who think existing features can be simplified or new features can be added to improve the project.
    • Users - Customers who want to clone the repository and use it create their own project.

Contributors


Amisha Waghela

Sanket Tangade

Tilak Satra

Owner

  • Name: Amisha Waghela
  • Login: amisha-w
  • Kind: user

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it using the metadata from this file."

authors:
  - family-names: Waghela
    given-names: Amisha
  - family-names: Tangade
    given-names: Sanket
  - family-names: Satra
    given-names: Tilak
title: "Lua to Python"
version: "1.0.0"
date-released: "01/24/2023"
doi: 10.5281/zenodo.7567006

GitHub Events

Total
Last Year

Dependencies

.github/workflows/pdoc.yml actions
  • actions/checkout v3 composite
  • actions/deploy-pages v1 composite
  • actions/setup-python v3 composite
  • actions/upload-pages-artifact v1 composite
.github/workflows/pylint.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v3 composite
  • cclauss/Find-Python-syntax-errors-action master composite
.github/workflows/style_checker.yml actions
  • andymckay/pycodestyle-action 0.1.3 composite
.github/workflows/tests.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v3 composite
  • codecov/codecov-action v2 composite
requirements.txt pypi
  • pdoc ==12.2.0