testpython.git

1) # testpython
2) 
3) This is just a test project. You can do anything here, test python
4) and IDE projects.
5) 

6) This branch is of Python 3 code. There's a python2 branch too.
7) 

8) ## Getting the project

9) 
10) You can get a copy of this project by clicking on the

11) [ZIP](https://git.dlma.com/testpython.git/zipball/main)
12) or [TAR](https://git.dlma.com/testpython.git/tarball/main) buttons

13) near the top right of the GitList web page.
14) 
15) You can clone from the origin with:
16) 
17)     git clone ssh://USERNAME@dlma.com/~/git/testpython.git
18) 

19) ## Supported IDEs

20) 

21) This project has example Visual Studio Code, PyCharm, Atom, and

22) Sublime Text 3 projects.

23) 

24) ### tmux vim entr
25) 
26) The best IDE of all, for those who live on the CLI. Create two panes in tmux,
27) run vim in one, and run entr in the other with a command like:
28) 

29)     git ls-files | entr -c sh -c 'ctags -R *; ./testpython.py'
30) 
31) or
32) 

33)     find . -type f -name \*.py | entr -c sh -c 'ctags -R *; ./testpython.py'
34) 

35) or to run in pdb:

36) 

37)     git ls-files | entr -c sh -c 'ctags -R *; python3 -m pdb testpython.py'

38) 
39) Tip: In vim you can do a multi-file grep and use the QuickFix window with commands like...
40) 
41)     :grep -rI searchterm .
42)     :cw
43) 

44) See [this QuickFix tip for sorting results by filename](https://git.dlma.com/dotfiles.git/commit/0cb566c53caf931c8b3f423dcfded4660b220cbb).

45) 

46) ### Visual Studio Code

47) 

48) Download Microsoft's Visual Studio Code from
49) [code.visualstudio.com](https://code.visualstudio.com/). Code uses the

50) [testpython.code-workspace](/testpython.git/blob/main/testpython.code-workspace)

51) project file. I prefer this to GitHub's Atom. Both are based on GitHub's Electron.

52) 

53) ### PyCharm

54) 

55) PyCharm uses the [.idea](/testpython.git/tree/main/.idea/) directory. JetBrains suggests [sharing the .idea directory

56) except for workspace.xml and tasks.xml](https://intellij-support.jetbrains.com/hc/en-us/articles/206544839).

57) 

58) ### Sublime Text 3

59) 

60) [Sublime](https://www.sublimetext.com/) uses the

61) [testpython.sublime-project](/testpython.git/blob/main/testpython.sublime-project) file.

62) 

63) ## Style

64) 

65) If you want your style similar to PEP-9, you can check the style of your code 
66) with ''pycodestyle'':

67) 

68)     pycodestyle --first --show-source --ignore=E501,W503 *.py

69) 

70) ## Requirements
71) 
72) requirements.txt specifies the requirements for Python modules and apps.
73) Install the requirements with:
74) 
75)     python3 -m pip install -r requirements.txt
76) 
77) ### Generating requirements.txt
78) 
79) Ideally, track why modules are required, create requirements.in with only the
80) the top-level requirements, and let pip-compile (from pip-tools) figure out the
81) next-level dependencies.
82) 
83)     (venv) $ python3 -m pip install pip-tools
84)     (venv) $ pip-compile requirements.in
85) 
86)  Otherwise, you can make requirements.txt directly with pip freeze:
87) 
88)     (venv) $ python3 -m pip freeze > requirements.txt
89) 

90) ## Current Features

91) 
92) * Multiple directories for testing build systems and IDEs
93) 

94) ## Is it any good?