dev_guidelines.md

Developer Guidelines

Setup

1. Setup a virtual environment

    $ pip install virtualenv
    $ virtualenv venv
    $ activate venv/bin/activate
   

2. Clone repo and install :::{important} Install make and jinja2-cli package ::: $ git clone $ cd $ make localdev

Package Maintainers

:::{important} Password less login to pypi creare .pypirc as mentioned in https://packaging.python.org/en/latest/specifications/pypirc ::: $ pip install -r dev-requirements.txt $ make build-push (default push to pypi repo) $ make build-push PUSH_TO=testpypi (one can specify where to push package)

Project Structure

Our WTRobot library lives in lib dir.

lib/
├── cli/                  // all click based file are here
│   ├── commands/         // if you want to add any new subcommand just add a new file here   
│   │   ├── clean.py
│   │   └── run.py
│   |── main.py
|
├── utils/               // All utility scripts are here 
│   ├── logger.py        // project logger script
│   └── util.py          // simple utility scripts like File I/O, etc
|
└── wt_lib/              // WTRobot core lib files    
    ├── action.py        // takes care of all selenium actions like click, input, etc
    ├── brower_init/     // initialize browser instance 
    │   ├── browser_options.py      // set brower options like locale, etc
    │   ├── grid_init.py            // config if you are using selenium grid    
    |   ├── init.py                 // brower init, this also uses weddriver_manager 
    |
    ├── commad_parser.py            // parser your test.yaml file
    ├── operations.py               // xpath parser, locate elements, etc
    |

Pull Requests

Dev is the Development branch and contributors are requested to raise PR against dev branch only.