Skip to content

rhelmstedter/eatlocal

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

forthebadge

eatlocal

Eatlocal helps the user solve PyBites code challenges locally. This cli tool allows you to download, unzip, and organize bites according to the expected structure from PyBites website. You can display bite directions directly in the terminal. Once you have solved the bite you can use eatlocal to submit and it will open a bowser tab at the corresponding bite page.

Updates

version 0.8.3

eatlocal is now compatible with Python 3.8. This matches the expected python version for the platform.

Breaking Changes

  • With version 0.8.0 there is a new eatlocal init command. Use this to configure your credentials and local git repository. You no longer need to set environment variables manually.
  • When displaying a bite, there is no longer a live display. The directions and source code are printed to the console. This eliminated the need for the getkey library and made installing eatlocal on windows easier.

DEMOS

Configure

gif of init command

Download Bites

gif of download command

Display Bites

gif of display command

Submit Bites

gif of submit command

Table of Contents

Usage

Set up your configuration file:

eatlocal init

Download and extract bites:

# use -V, --verbose to print what's happening
eatlocal download <bite number>

Display bites in the terminal:

# change the theme with -t <theme name>
eatlocal display <bite number>

Submit bites:

# use -V, --verbose to print what's happening
eatlocal submit <bite number>

Installation

There are a few options for install eatlocal.

Using pipx

If you have pipx installed:

pipx install eatlocal

macOS/Linux

pip3 install eatlocal

Windows

pip install eatlocal

Setup

  1. Go through the directions on the PyBites website to connect your GitHub account to your PyBites account. You will find the necessary steps under Settings in the navigation sidebar.
  2. Run eatlocal init to configure your PyBites username, PyBites password*, and local git repository.
  3. Make sure you have Chrome and chromedriver installed and on $PATH. The chromedriver version must match the version of your Chrome browser. Chromedriver downloads.

*Note: If you signed up for PyBites by authenticating through GitHub or Google, you may need to set a password manually in order to use eatlocal.

Install Chrome and Chromedriver

macOS

One option is to use homebrew homebrew.

Install chrome:

brew install --cask google-chrome

Install chromedriver:

brew install chromedriver

Before you run chromedriver for the first time (and after you update versions), you must explicitly give permission since the developer has not been verified. Running the following command in the terminal removes the warning put in place by Apple:

xattr -d com.apple.quarantine $(which chromedriver)

Homebrew automatically puts chromedriver on $PATH for you. And since homebrew handles both chrome and chromedriver installations for me, I can run brew update && brew upgrade to help ensure I have the same version number for both chrome and chromedriver. If you do not go the homebrew route, you must manually ensure that your version of chrome matches the version of chromedriver.

Linux

Navigate to the download page for google chrome and download the appropriate version for your system. Then, open up a terminal and navigate to where you downloaded the file. For me it was ~/Downloads. I ran the following commands to install and check which version I have.

cd ~/Downloads
sudo dpkg -i google-chrome-stable_current_amd64.deb
google-chrome --version

Next, navigate to the chromedriver download page and choose the version that matches the output from google-chrome --version. Download that file that matches your system. Head back to your terminal.

  1. Ensure that you have unzip installed:
sudo apt install unzip
  1. Unzip the chromedriver file. For me it was located in the downloads folder:
unzip ~/Downloads/chromedriver_linux64.zip -d ~/Downloads
  1. Make it executable and move to /usr/local/share:
chmod +x ~/Downloads/chromedriver
sudo mv -f ~/Downloads/chromedriver /usr/local/share/chromedriver
  1. Create symlinks:
sudo ln -s /usr/local/share/chromedriver /usr/local/bin/chromedriver
  1. Confirm you have access:
which chromedriver

Windows

If working in windows powershell you can use chocolately to install both Chrome and chromedriver (with matching versions).

I've found that in order to install packages I have to use an elevated administrative shell, with choco install chromedriver.

chromedriver in chocolatey

WSL

eatlocal does not work with WSL2. There seems to be an issue between WSL2 and google-chrome and chromedriver. Perhaps this will be resolved in the future with WSLg. For now, there is a workaround: Follow instructions for Windows users except install eatlocal globally. Using PowerShell or Windows Terminal, navigate to your WSL distribution's directory that holds your repository and initialize eatlocal from there. Now just download and submit through your external PowerShell command line instead of your bash terminal. Everything should still behave the same, you just can't use your WSL shell or your integrated terminal in VS Code.

About

This package helps users solve PyBites code challenges on their local machine.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 96.0%
  • HTML 4.0%