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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
|
# Development
Before you get busy coding a new feature, create an issue and discuss the details in the issue tracker.
## Environment set-up
This guide assumes you have a [GitHub](https://github.com) account, as well as [Python 3](https://python.org), [virtualenv](https://virtualenv.pypa.io/en/stable/) and [Git](https://git-scm.com) installed. The guide is written for Bash, for Windows you can use for example Bash bundled with Git.
* [Fork](https://github.com/r0x0r/pywebview/fork) _pywebview_
* Clone your forked repository
``` bash
git clone https://github.com/<username>/pywebview
cd pywebview
```
* Create a virtual environment
``` bash
virtualenv -p python3 venv
source venv/bin/activate
pip install -e .
pip install pytest
```
* Hello world
``` bash
python examples/simple_browser.py
```
## Development work-flow
* Create and checkout a new branch
``` bash
git checkout -b new-branch master
```
* Make your changes
* Run tests
``` bash
pytest tests
```
* Commit and push your work
``` bash
git add .
git commit -m "Your commit message goes here"
git push -u origin new-branch
```
* [Create a pull request](https://help.github.com/articles/creating-a-pull-request/)
## Testing
pywebview uses [pytest](https://docs.pytest.org/en/latest/) for testing.
To run all the tests in the project root directory
``` bash
pytest tests
```
To run a specific test
``` bash
pytest tests/test_simple_browser.py
```
Tests cover only trivial mistakes, syntax errors, exceptions and such. In other words there is no functional testing. Each test verifies that a pywebview window can be opened and exited without errors when run under different scenarios. Sometimes test fail / stuck randomly. The cause of the issue is not known, any help on resolving random fails is greatly appreciated.
## Learning
### Windows
* [Windows Forms documentation](https://docs.microsoft.com/en-us/dotnet/framework/winforms/)
* [Windows Forms API](https://docs.microsoft.com/en-us/dotnet/api/system.windows.forms)
### macOS
* [pyobjc](https://pythonhosted.org/pyobjc/). Converting Objective C syntax to Python can be tricky at first. Be sure to check out the [pyobjc intro](https://pythonhosted.org/pyobjc/core/intro.html).
* [AppKit](https://developer.apple.com/documentation/appkit)
* [WebKit](https://developer.apple.com/documentation/webkit)
### Linux
* [PyGObject API reference](https://lazka.github.io/pgi-docs/)
### Qt
* [Qt for Python Documentation](https://doc.qt.io/qtforpython-5/contents.html)
* [Qt5 documentation](https://doc.qt.io/qt-5/index.html)
* [PySide2 QtWidgets](https://doc.qt.io/qtforpython-5/PySide2/QtWidgets/index.html)
|
