Skip to content

An all-in-one utility to interact with UCLA's SEASnet servers, prototyped in Python

License

Notifications You must be signed in to change notification settings

awolk/SEASide-py

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

About

An all-in-one utility to interact with UCLA's SEASnet servers, prototyped in Python

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages