-
Notifications
You must be signed in to change notification settings - Fork 0
/
README
60 lines (54 loc) · 1.84 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
File Structure
--------------
* main.py - Starts program
* app.py - Main App
* connection.py - Interface to SSH and SFTP server
* server_config.py: SEASnet server information
* savedata.py: Interface to access configuration files
* term_em.py - Terminal emulator interface
* gui/
* main_window.py - Master window
* master_tab.py - Single tab for unique connection
* loader.py - Tab loading widget
* login.py - Login widget
* connection_view.py - Connected tab: holds terminal and file explorer
* terminal.py - Terminal Widget
* fileexplorer.py - File Explorer Widget
Project Setup Guide
-------------------
To create your virtual environment, from project directory:
pipenv install
To select the virtual environment in PyCharm:
Preferences
Project: SEASide
Project Interpreter
Project Interpreter: Show all
+: Add local
Existing environment
Find and select your pipenv virtual environment
To run through PyCharm:
Right click the 'src' directory
Mark directory as -> Sources root
Select empty selector on top right
Edit Configurations
+ -> Python
Name: SEASide
Script path: src/main.py
Working directory: set to repository directory
Version Control
---------------
General Guidelines:
* Major changes should be done in branches
* Commit messages should be descriptive and written as actions:
Ex: Add login fields and error message to GUI
Making a major change that should be reviewed by someone:
VCS -> Commit
VCS -> Create Pull Request
Once the pull request is created, assign reviewers
When you want to push your changes to master on GitHub:
VCS -> Commit
VCS -> Git -> Fetch
On the bottom-right of the window:
Git
Remote Branches: origin/master -> Merge
VCS -> Git -> Push