/ncsu_se_fall22_22_hw2-5

This repo contains the code for HW 2-5 for group 22 in SE Fall 2022 class at NCSU

Primary LanguagePythonMIT LicenseMIT

NCSU_SE_Fall22_22_hw2_5

Migrating csv.lua to Python based library

GitHub Github GitHub issues Github closed issues Github pull requests Github closed pull requests Github all contributors Run lint and tests Code coverage DOI

Getting started:

  • Prerequisite:

  • Installation:

    • Install all the requirements:

      pip install -r requirements.txt

  • Run Instructions

    • Clone this (LUA to Python) github repo.

    • Navigate to the project root directory

    • Run:

      • Test:

        • To run all tests, run the command python -m src.main -e ALL

        • To run a specific test, run the command python -m src.main -e <test-name>

        • To see a list of test names, run the command python -m src.main -e LS

        • To see the help section, run the command python -m src.main -h

        • If any of the tests fail, use -d flag to see stack trace

Directory structure

.
├── .github
│   ├── workflows          
│   │   ├── run-test.yml            # Workflow for git actions
├── Docs
│   ├── TestFile.md                 # Test file
|   ├── src
|   |   ├── *.html                  # Documentation files per file
├── data
|   ├── README.md                   # Readme file for data folder
|   ├── constants.py                # Contains constants to be used by other code
|   ├── input.csv                   # Input file used for testing the logic
├── src
│   ├── Num.py                      # Num class to get mid & div
│   ├── __init__.py                 # Init file for src directory
|   ├── cols.py                     # Cols class with its methods
|   ├── data.py                     # Data class to handle data from csv
│   ├── main.py                     # Main file for src directory
│   ├── misc.py                     # File for all miscellaneous functions
|   ├── row.py                      # Rows class with its methods
│   ├── sym.py                      # Sym class to get mid & div
├── tst
│   ├── README.md                   # Readme file for unit tests
│   ├── __init__.py                 # Init file for tst directory
│   ├── testEngine.py               # Contains code for test engine
│   ├── test_*.py                   # Specific test files
├── .all-contributorsrc             # File for all-contributor bot
├── .gitattributes                  # File for git attributes
├── .gitignore                      # File for git ignore
├── CODE_OF_CONDUCT.md              # Code of conduct for repository
├── CONTRIBUTING.md                 # Details about contributing to the repository
├── LICENSE.md                      # MIT License details
├── README.md                       # Readme file for repository
├── requirements.txt                # Details of dependency packages
├── INSTALL.md                      # Installation steps for complex packages
└── setup.py                        # Setup file for the module

Roadmap

Contributors ✨

All Contributors

Thanks goes to these wonderful people (emoji key):


nagaraj madamshetti
🚇 ⚠️ 💻
Akash Gupta
🚇 ⚠️ 💻
Arunsp2000
💻
Nitesh Mishra
🚇 ⚠️ 💻
sumitsinghhazard
🚇 ⚠️

This project follows the all-contributors specification. Contributions of any kind welcome!