semvec/pypi-packages huggingface dataset:
GBBatteries-Take-Home-Challenge 1.1.0
Parsing text file to json

Installation required:
Python 3 (https://www.python.org/downloads/)
Text editor of your choice for verifying or editing files

How to run:
1) Create a text file in your desired location that you would like to parse.  Use this format (space delimited):  
    Number String/Number Number 
2) In your text editor of choice, change the moving average filter (num_samples) to your desired amount (default to 3).
3) From the base directory, run this command: python -m Parser
4) Follow the prompts that it gives you: Select your location for source file, and where you would like the output file to go (as well as the name)
5) The input file will now be parsed, and placed in the location you specified.  
6) Check the log file for any potential errors while parsing the file!  It will be in the base directory

How to test Parser.py:
1) Tests are stored in the module folder under /tests
2) TestData.txt and BadData.txt should be in the directory, containing example data for testing the file. (DO NOT CHANGE THESE FILES.  They were designed to test specific functionality)
3) From the base directory, run this command: Python -m unittest
** The test cases will run and output to the command line to check that error handling is working, as well as checking the correct output is unchanged.  (3 inputs per line, with an integer for the 3rd input)
*** The log file will be overwritten for the test cases

How to publish to PyPi:
1) Install twine through the command line: pip install twine
2) Install wheel through the command line: pip install wheel
3) From the base directory, run this command from the command line to create distributions of the project: python setup.py sdist bdist_wheel
** This should create 2 seperate files, one .whl and one .tar.gz file
*** Feel free to edit the setup.py file in the base directory of this package (there is currently one there that you are free to edit)
4) Test to make sure all files are present
5) Run this command in the base directory to check the distribution: twine check dist/* 
6) Upload from the base directory using the following command: twine upload dist/*
*** Note:  You will need an account at https://pypi.org/