The goal of this repository is to verify that your development environment is set up to start working on code at dYdX. Successfully running the tests in this repo confirms that your environment is close to or completely set up to work with dYdX repositories.
We also provide examples of common enums you will encounter at dYdX in src/constants.py. These objects are then used and tested in tests/test_basic_flow.py.
Setup your ssh key be able to clone the repository by following the instructions here
Clone the repository with one of the following
git clone git@github.com:dydxprotocol/py-systemCheck.git
Create a new branch locally
git checkout -b <branch_name>
Stage files to be committed
git add <file_names>
Add a commit with a message
git commit -m "<message>"
Push to the remote branch
git push origin <branch_name>
Create the pull request on github.com from your branch to master
Here is a list of helpful git commands.
Pick a text editor you are comfortable with. Most editors should have javascript support. Many engineers at dYdX use VSCode or Atom.
Many dYdX clients are written in Python and the latest Python can be installed as such:
brew install python
If you do not have brew installed, follow this guide here.
We install packages with pip: follow these step.
To install all packages needed for the repo:
pip install -r requirements.txt
- Run
pip install -U pytestif you do not have pytest installed. - Run your tests with
pytest. You can add a test filename as an optional argument if you don’t want to run the whole test suite. This command pattern matches for all files with test_*.py so you don’t need to include the entire path, for examplepython -m pytest tests/test_basic_flow.py.