Skip to content

Latest commit

 

History

History
61 lines (50 loc) · 2.19 KB

DeveloperNotes.md

File metadata and controls

61 lines (50 loc) · 2.19 KB
Raw

Automated GitHub access

Create a token on GitHub with repository privileges. Make sure to check the read:packages permission -- this will be needed for shared Vue packages later on. You may need to check the repo scope.

Create ~/.netrc if it doesn't exist:

touch ~/.netrc
chmod 600 ~/.netrc

Then add this to it:

machine github.com login TOKEN_YOU_JUST_MADE

MacOS environment configuration

# Install brew
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

# Install python3
brew install python3
export PATH=/usr/local/share/python:$PATH

# Install virtualenv
pip3 install virtualenv virtualenvwrapper

# Note: if you are using anaconda, you may need to search for virtualenvwrapper.sh
# Start by querying for `which python3`, then run `find . | grep virtualenv`

# Add these commands: to your ~/.bash_profile or ~/.zshrc
export PATH=/usr/local/share/python:$PATH
export WORKON_HOME=$HOME/.virtualenvs
export VIRTUALENVWRAPPER_PYTHON=/usr/local/bin/python3
export VIRTUALENVWRAPPER_VIRTUALENV=/usr/local/bin/virtualenv
source /usr/local/bin/virtualenvwrapper.sh

Development

git clone https://github.com/datakind/new-america-housing-loss-tool
cd new-america-housing-loss-tool/cli
mkvirtualenv -p $(which python3) -a $PWD new-america-housing-loss
pip install --upgrade pip
make requirements
make test

Creating a branch

To create a branch in Github, first run the instructions above to install the package, then follow the procedure below to create and push a branch to the repository.

git pull origin main  # Pull the latest changes from the repository
git checkout -b my-branch main  # Create a new branch
# Make changes to python files and create tests as needed
cd new-america-housing-loss-tool/cli  # Ensure this directory is active
make format  # Run automation to automate formatting changes
make test  # Run automated tests and look for errors
git commit -m "description of your changes" your/file.py  # Commit local changes
git push origin my-branch  # Push local changes to the repository