Setup Development Environment#

This guide is intended for people who have never contributed to an open source project on GitHub before. If you have already completed the steps in this guide, you do not need to complete them again.

Note

This guide is intended for people have never contributed to an open source project on GitHub before. If you are already familiar with how to contribute to an open source project on GitHub, go to the Development Workflow Process guide

The first step to contributing to the code base is creating your development environment.

Important

Each of the steps in this guide only need to be done once. Once you have completed them, you do not need to repeat them, even if you are making a second contribution.

Install Git#

SymPy is available on GitHub and uses Git for source control. The workflow is such that code is pulled and pushed to and from the main repository. Install the respective version of Git for your operating system to start development.

Linux-like systems:

Install git via your native package management system:

yum install git

or:

sudo apt-get install git

Windows and macOS:

The easiest way to get git is to download GitHub desktop, which will install git, and also provide a nice GUI (this tutorial will be based on the command line interface). Note, you may need to go into the GitHub preferences and choose the “Install Command Line Tools” option to get git installed into the terminal.

If you do decide to use the GitHub GUI, you should make sure that any “sync does rebase” option is disabled in the settings.

Configure Your Name and Email in Git#

Git tracks who makes each commit by checking the user’s name and email. In addition, we use this info to associate your commits with your GitHub account.

To set these, enter the code below, replacing the name and email with your own (--global is optional).:

git config --global user.name "Firstname Lastname"
git config --global user.email "your_email@youremail.com"

The name should be your actual name, not your GitHub username. Use the email you used for your GitHub account (see below).

(Optional) Configure Git Settings#

This step is not required, but it can make working with git on the command line easier.

These global options (i.e. applying to all repositories) are placed in ~/.gitconfig. If you want, you can edit this file to enable some handy shortcuts:

[user]
    name = Firstname Lastname
    email = your_email@youremail.com

# Some helpful aliases to save on typing
[alias]
    ci = commit
    di = diff --color-words
    st = status
    co = checkout
    log1 = log --pretty=oneline --abbrev-commit
    logs = log --stat

See https://git-scm.com/book/sv/v2/Customizing-Git-Git-Configuration for some more common git configuration options.

Setup GitHub#

Next you will need to setup your GitHub account. Note that all the steps here only need to be done once. If you already have a GitHub account and have setup SSH keys, even if it was for a different project than SymPy, you do not need to do them again.

Create a GitHub Account#

A GitHub account is required to contribute to SymPy. If you have not one yet then sign up at https://github.com/join. Your GitHub account is your presence in the open source world, so we recommend choosing a professional username.

Setup SSH Keys#

To establish a secure connection between your computer and GitHub see detailed instructions in https://docs.github.com/get-started/getting-started-with-git/set-up-git or at https://docs.github.com/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.

If you have any problems with SSH access to GitHub, read the troubleshooting instructions at https://docs.github.com/authentication/troubleshooting-ssh, or ask us on the mailing list.

Fork SymPy#

Create your own fork of the SymPy project on GitHub. If you have already done this before, you do not need to do it again.

Go to the SymPy GitHub repository and click the Fork button.

Now you have your own repository for the SymPy project. The address of the forked project will look something like https://github.com/<your-github-username>/sympy, where <your-github-username> is your GitHub username.

Get the SymPy Code#

It is recommended practice to create a fork of the SymPy project for your development purposes. Create your own fork of the SymPy project (if you have not yet). Go to the SymPy GitHub repository:

https://github.com/sympy/sympy

You will now have a fork at https://github.com/<your-user-name>/sympy.

Then, on your machine browse to where you would like to store SymPy, and clone (download) the latest code from SymPy’s original repository (about 77 MiB):

$ git clone https://github.com/sympy/sympy

Then assign your read-and-write repo to a remote called “github” (replace <your-github-username> with your GitHub username):

git remote add github git@github.com:<your-github-username>/sympy.git

For more information about GitHub forking and tuning see: https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests, https://docs.github.com/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo, and https://docs.github.com/get-started/quickstart/set-up-git

After the configuration, your setup should be similar to this:

$ git remote -v
origin   https://github.com/sympy/sympy (fetch)
origin   https://github.com/sympy/sympy (push)
github https://github.com/<your-github-username>/sympy (fetch)
github https://github.com/<your-github-username>/sympy (push)

Virtual Environment Setup#

You may want to take advantage of using virtual environments to isolate your development version of SymPy from any system wide installed versions, e.g. from apt-get install python-sympy.

If you use conda, you can use it to create a virtual environment:

$ conda create -n sympy-dev -c conda-forge --file requirements-dev.txt

If you prefer to use pip and venv, you can use something like

cd sympy
python -m venv .venv
source .venv/bin/activate
pip install -r requirements-dev.txt

You can add any other packages to this command that you might find useful for your contribution, such as the optional dependencies.

You now have a environment that you can use for testing your development copy of SymPy.

Now activate the environment:

$ conda activate sympy-dev