Skip to content
data collection tool to aid in better management of the BGS
Python
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.editorconfig
.env-example
.gitignore
.pylintrc 2.1.0: refactor; add progress report Sep 11, 2018
README.md
canonnevents.py
cgt.py
data.py Post market data #48 Sep 22, 2018
exploration.py
forward.py
influence.py
load.py put in missing comma's May 28, 2019
local.py
market.py
news.py
pack.py Stop being a "package plugin"; defend ourselves Sep 20, 2018
panic.py Panic #58 Sep 28, 2018
plugin.py Fix LOCAL command status updates Sep 12, 2018
progress.py Update progress after FactionKillBond #51 Sep 22, 2018
setup.cfg Drag code to common style Sep 2, 2018
shopping.py GET explosystem and besthuttonrun #55 Sep 27, 2018
toolbar.py
updater.py
version.py
widgets.py
xmit.py

README.md

hutton-helper

A plugin for the Elite Dangerous Market Connector, specifically written for the Hutton Orbital Truckers.

Development Setup

Getting set up takes a few steps because EDMC is fussy, and because code editors like Visual Studio Code need to see the modules EDMC provides while we're developing.

DON'T PANIC: these instructions are long only because

  • We're trying to make it really hard to screw up, and

  • We're trying to leave your existing copy of Python unbroken

For the mug! Do this:

  • Install git

  • Install the 32 bit version of Python 2.7 to c:\Program Files (x86)\Python27

    EDMC wants the 32 bit version. These instructions want that path. If you're willing to edit the path every time you cut and paste while you set up, no worries, put it anywhere you like. You'll only have to do it a few times.

    Don't over-write your existing Python! These instructions will help you leave it just how you like it.

  • Download get-pip.py, e.g. to %TEMP%

  • Install pip:

    "c:\Program Files (x86)\Python27\python.exe" "%TEMP%\get-pip.py" --user
    
  • Install virtualenv:

    "c:\Program Files (x86)\Python27\python.exe" -m pip install virtualenv --user
    
  • Change directory to wherever your code lives. If you don't know where that is:

    cd %HOMEPATH\Documents
    mkdir source
    cd source
    
  • Clone EDMarketConnector and hutton-helper:

    git clone https://github.com/Marginal/EDMarketConnector.git
    git clone https://github.com/aarronc/hutton-helper.git
    
  • Set up the virtual environment:

    cd hutton-helper
    "c:\Program Files (x86)\Python27\python.exe" -m virtualenv .
    
  • Activate the virtual environment:

    Scripts\activate
    

    You'll activate each time you resume development. It sets everything up so you're using a copy of Python in hutton-helper. That 32-bit Python you set up will remain pristine, apart from pip and virtualenv. Your usual 64-bit copy of Python 3 won't be touched at all.

    Which is good, because now we need to get dirty.

  • Install everything EDMC needs, plus a couple extras:

    cd ..\EDMarketConnector
    pip install -r requirements.txt
    pip install pylint pep8 rope
    
  • Launch EDMC for a test:

    python EDMarketConnector.py
    
  • Read the output in your command line window for the location of wherever you've had hutton-helper installed:

    Loading plugin hutton-helper from "C:\Users\sporebat\AppData\Local\EDMarketConnector\plugins\hutton-helper\load.py"

  • Shut down EDMC

  • Start a new command window for the next few steps:

    start
    
  • In that window, change directory to wherever plugins was above:

    cd "C:\Users\sporebat\AppData\Local\EDMarketConnector\plugins"
    

    If you're lucky, this'll work:

    cd "%LOCALAPPDATA%\EDMarketConnector\plugins"
    
  • Disable that install of hutton-helper, then link in your development copy:

    ren hutton-helper hutton-helper.disabled
    junction "hutton-helper" "%HOMEPATH%\Documents\source\hutton-helper"
    

    (If your source code lives somewhere, you'll need to adjust that second command.)

  • Throw away that command line window:

    exit
    
  • BASK IN HER GLORY. You're all set up!

VS Code Setup

To set up Visual Studio Code for developing hutton-helper, install the EditorConfig and Python extensions:

code --install-extension EditorConfig.EditorConfig
code --install-extension  ms-python.python

Then, copy the following JSON to .vscode\settings.json in your hutton-helper directory:

{
  "files.exclude": {
    "**/.git": true,
    "**/*.pyc": true,
    "Scripts": true,
    "Include": true,
    "Lib": true,
    "tcl": true
  },
  "python.pythonPath": "Scripts\\python.exe",
  "python.linting.enabled": true,
  "python.linting.pep8Enabled": true,
  "python.linting.pylintUseMinimalCheckers": false
}

Finally, create a .env file in hutton-helper containing:

PYTHONPATH=..\EDMarketConnector

To launch your editor from that directory:

code .

Development

To resume development:

cd "%HOMEPATH%\Documents\source\hutton-helper"
Scripts\activate
code .

Release

del *.zip
python pack.py

... then upload the .zip file and version.json to the release directory.

You can’t perform that action at this time.