nibble-4bits / codewars-solutions-scraper

A scraper that gets the solutions of all of the CodeWars katas you have solved

Codewars Solutions Scraper

A command line tool that scrapes the solutions of all the CodeWars katas you have solved.

Installation

To install the tool simply run the following command in a terminal:

npm install -g codewars-solutions-scraper

And the command codewars-solutions-scraper will be installed globally in your system and ready to use.

Usage

codewars-solutions-scraper [options]

Options:
  -V, --version              output the version number
  -c, --codewars             use CodeWars login credentials
  -g, --github               use GitHub login credentials
  -o, --output <path>        path to the output directory where solutions will be saved (default: <YOUR_HOME_DIRECTORY>/my_codewars_solutions)
  -v, --verbose              explain what is being done
  -d, --debug                run the scraper in debug mode (will make browser window appear to see what is being done)
  -u, --username <username>  your CodeWars username
  -e, --email <email>        your GitHub or CodeWars account email
  -p, --password <password>  your GitHub or CodeWars account password
  -h, --help                 display help for command

• NOTE: -c and -g options are mutually exclusive.

Examples

Logging in using GitHub

If you want to log in to CodeWars using your GitHub credentials then run:

codewars-solutions-scraper -g -u <YOUR_CODEWARS_USERNAME> -e <YOUR_GITHUB_EMAIL> -p <YOUR_GITHUB_PASSWORD>

Note that if you log in via GitHub, you will be prompted to enter a verification code sent to your GitHub account email.

The prompt will look like this:

Please enter the verification code that was sent to <YOUR_GITHUB_EMAIL>:

When you receive the verification code, just type it in and press Enter.

Logging in using CodeWars

If you want to log in to CodeWars using your CodeWars credentials then run:

codewars-solutions-scraper -c -u <YOUR_CODEWARS_USERNAME> -e <YOUR_CODEWARS_EMAIL> -p <YOUR_CODEWARS_PASSWORD>

Specifying an output directory

If you want to save your solutions in a custom directory then use the -o, --output option:

codewars-solutions-scraper -g -o /path/to/custom/dir -u <YOUR_CODEWARS_USERNAME> -e <YOUR_GITHUB_EMAIL> -p <YOUR_GITHUB_PASSWORD>

Built With

• Puppeteer
• Commander
• Inquirer
• Chalk

License

GPL-3.0 License

codewars-solutions-scraper's Issues

Add support for Perl file extension

Codewars recently added support for Perl katas, thus Perl solutions will have a .txt file extension instead of .pl

See example

Use latest version of Puppeteer

Would not run with old puppeteer, had to change to latest and then it worked fine

Change to Unix line endings

Package does not run on Linux due to dos line endings. Should work on Windows and Linux if line endings are changed to Unix style