Skip to content

Latest commit

 

History

History
66 lines (38 loc) · 2.26 KB

CONTRIBUTING.md

File metadata and controls

66 lines (38 loc) · 2.26 KB
Raw

Contribution

Requirements

  • Python 3.6
  • Git CLI installed
  • Python, pip and git are all available as command-line commands (add to path if needed)

Virtual environment will be created in PyfaEnv folder. Project will be cloned and run from the PyfaDEV folder. Separate virtual environment will be created so required libraries won't clutter the main python installation.

Setting up the project manually

Clone the repo git clone <repo> PyfaDEV

Create virtual environment python -m venv PyfaEnv

Activate virtual environment

For cmd.exe: PyfaEnv\scripts\activate.bat
For bash: source <venv>/bin/activate

For other OS check Python documentation

Install requirements for the project from requirements.txt pip install -r PyfaDEV\requirements.txt

Check that libs from requirements.txt are installed pip list

Test that the project is starting properly python PyfaDEV\pyfa.py

Setting up the project with PyCharm/IntelliJ

Install PyCharm / Other IntelliJ product with Python plugin

After launching select Check out from Version Control -> GIt

welcome

Login to GitHub, paste repo URL and seect the folder to which to clone the project, press Clone.

Clone

After process is complete, open File -> Settings -> Project -> Project Interpreter.

Settings

Press on options and add new virtual environment.

venv

Open project tree view and double-click on requirements.txt. Press Install requirements. Install all requirements.

Reqs

Create new Run Configuration. Set correct Script path and Python interpreter.

Run configuraion

Test that the project is starting properly.