<commit_before>pyCourseSync
============

A clone of the original CourseSync client written in Python 3.

Dependencies
============

pyCourseSync uses some of the best libraries available for Python 3 to accomplish the task.
The libraries required for pyCourseSync to work are:
1. BeautifulSoup4: This is an absolutely amazing library for parsing and navigating Web Pages.
2. Requests: This stunningly simple library was chosen over the built-in urllib library after a lot of consideration. It provides the simplest and easiest HTTP Client API I have ever seen.<commit_msg>Improve documentation in Readme file<commit_after>pyCourseSync
============

A clone of the original CourseSync client written in Python 3.

Dependencies
============

pyCourseSync uses some of the best libraries available for Python 3 to
 accomplish the task.

The libraries required for pyCourseSync to work are:
    * BeautifulSoup4: This is an absolutely amazing library for parsing and
      navigating Web Pages.
    * Requests: This stunningly simple library was chosen over the built-in
      urllib library after a lot of consideration. It provides the simplest and
      easiest HTTP Client API I have ever seen.

Usage
=====

```
usage: CourseSync.py [-h] [-a | -d | -r] [-S] [-v {q,v,d}] [-l]

optional arguments:
  -h, --help            show this help message and exit
  -a, --add-courses     Add courses to your Course List
  -d, --delete-courses  Remove courses from your Course List
  -r, --reset           Delete your Course List file and start a new one.
                        Helpful when starting a new semester
  -S, --sync            Sync your machine with the CMS Servers
  -v {q,v,d}, --verbosity {q,v,d}
                        Change verbosity of script output
  -l, --view-logs       View the contents of your Log File
```

Using pyCourseSync is very easy. Use the --add-courses or --delete-courses to
change what data is synced from the CMS.

Then leave this script in your startup applications so that it syncs with the
CMS on every system startup. In case you leave your system ON for multiple days,
set up a scheduled task to execute pyCourseSync.

The verbosity and logging options are currently not implemented and will
hopefully be implemented soon, by V1.0

Credits
=======

The original CourseSync client was written by <NAME> and Aravind
Pedapudi in Perl and can be found at: https://github.com/ajit-kolathur/CMS
This was the inspiration based on which pyCourseSync is written.

Authors
=======

    * <NAME>  <<EMAIL>>
{'fraction_non_alphanumeric': 0.07822994863690241, 'fraction_numerical': 0.0039510075069142635, 'mean_word_length': 3.335616438356164, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 1, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '845537', 'n_tokens_mistral': 686, 'n_tokens_neox': 647, 'n_words': 351}