eatlocal 0.7.6

eatlocal helps the user solve PyBite code challenges on their local machine

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 the directions on the PyBites website. Once you have solved the bite you can use eatlocal to submit and it will open a bowser tab at the correct location.

DEMOS

Download Bites

Display Bites

Submit Bites

Table of Contents

• Usage
• Installation
  • macOS/Linux
  • Windows
• Setup
  • Install Chrome and Chromedriver
    • macOS
    • Linux
    • Windows
  • PyBites Credentials and Local Repo
    • macOS/Linux
    • Windows

Usage

Navigate to your local PyBites repo.

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

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.
2. Make sure you have Chrome and chromedriver installed and on $PATH.
3. Create environment variables for your PyBites username and password (PYBITES_USERNAME and PYBITES_PASSWORD respectively). 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.
4. Create an environment variable for you local Pybites repo(PYBITES_REPO).

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, 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

Unfortunately, I did not find some fancy package manager for Linux, but I was able to install chrome and chromedriver manually for Linux Mint.

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

2. Unzip the chromedriver file. For me it was located in the downloads folder:

unzip ~/Downloads/chromedriver_linux64.zip -d ~/Downloads

3. Make it executable and move to /usr/local/share:

chmod +x ~/Downloads/chromedriver
sudo mv -f ~/Downloads/chromedriver /usr/local/share/chromedriver

4. Create symlinks:

sudo ln -s /usr/local/share/chromedriver /usr/local/bin/chromedriver

5. Confirm you have access:

which chromedriver

Windows

If working in windows powershell you can use chocolately to install chromedriver.

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

I attempted to use eatlocal from WSL2 but there seems to be an issue with google-chrome itself. I could not get it to work.

PyBites Credentials and Local Repo

You must have your PyBites username and password stored in the environment variables PYBITES_USERNAME and PYBITES_PASSWORD respectively. Your local PyBites Repo should be stored in the environment variable PYBITES_REPO.

If you have cloned the repo, you can use the conveniently provided .env-template to store your credentials. Copy the template and save as .env. Then set your username and password on two separate lines.

# set username and password
PYBITES_USERNAME=<username>
PYBITES_PASSWORD=<password>
PYBITES_REPO=</path/to/local/repo>

macOS/Linux

There are two methods to handle this in.

Virtual Environment Method

A note of warning: If you use this method make sure that your virtual environment is not being pushed to GitHub. If you accidentally push your virtual environment—clearly that has never happened to me—then you have exposed your password and should change it immediately.

1. Create a virtual environment for your PyBites repo:

python3 -m venv .venv

2. Add the line .venv to your .gitignore file.

echo ".venv" >> .gitignore

3. With the environment deactivated, use your favorite text editor (I use nvim, btw) to open the activate file, e.g., nvim .venv/bin/activate and add the following lines:

export PYBITES_USERNAME=<username>
export PYBITES_PASSWORD=<password>
export PYBITES_REPO=</path/to/local/repo>

4. Activate the environment source .venv/bin/activate.

Shell RC Method

If you are not using a virtual environment, you can add the variables directly to your shell config.

1. I use zsh. So I would use my favorite text editor nvim ~/.zshrc and set the variables by adding the same three lines as above:

export PYBITES_USERNAME=<username>
export PYBITES_PASSWORD=<password>
export PYBITES_REPO=</path/to/local/repo>

2. Either exit your terminal completely and reopen, or source your config file with source ~/.zshrc.

Windows

I don't know of a way to do this other than graphically (Booo!). If you like pictures follow this tutorial.

1. Open the Start menu by pressing the “Windows Key”.
2. Type “Environment variables” and click on the “Edit the system environment variables” result.
3. Click on the "Advanced" tab.
4. Click "Environment Variables".
5. Under "User variables" click "New".
6. In the "Variable name" field enter: PYBITES_USERNAME
7. In the "Variable value" field enter:
8. Repeat steps 5-7 for the password variable.
9. Repeat steps 5-7 for the repo variable.
10. Click "Ok"
11. Click "Apply"
12. Restart your computer.