2. Setting up a development environment

This guide will help you set up a working development environment for Tsune

2.1. Requirements

  1. A working and configured Git (download)
  2. VirtualBox compatible with Vagrant (download)
  3. Vagrant (download)
  4. PyCharm Professional (download)
  5. VirtualBox installation folder in PATH environment variable

2.2. Setting up Vagrant

  1. Open PyCharm
  2. Select Open from Version Control
  3. Select either Github or Git and input the repository information
  4. When asked whether PyCharm should open the project for you, select Yes
  5. Select Tools > Vagrant > Up and wait for Vagrant to finish. This will take a long time (~30min), so grab a coffee or get some sleep. When it’s finished, you will see Process finished with exit code 0

2.3. Setting up the remote python interpreter

  1. Select File > Settings and click on Project Interpreter > Configure Interpreters
  2. Click the + button on the right and select Remote...
  3. Click Fill from vagrant config and Ok
  4. Click Test Connection. Answer the authenticity warning with Yes and click Ok
  5. Click Ok to close the interpreter setup and wait for the process to finish. This may take a few moments
  6. When asked whether you want to set the interpreter as Project Interpreter, select Yes
  7. Click Ok to close the settings window

2.4. Configure Django integration

  1. Select File > Settings and click on Django Support. Make sure that Enable Django Support is ticked

  2. Click the ... button next to Settings. Select tsune/settings.py. Click Ok

  3. Close the Settings window with Ok

  4. Click Run > Edit Configurations

  5. If Django server has an entry named tsune, select the entry and continue with step 7

  6. Click the + button. Select Django server

  7. Configure everything exactly as follows:

    Name: tsune Host: 0.0.0.0 Port: 8000 Run Browser: http://127.0.0.1:8080

  8. Close the Run configurations dialog by clicking Ok

Read the Docs v: latest
Versions
latest
doku
Downloads
PDF
HTML
Epub
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.