Skip to content

Commit c6aacf4

Browse files
authored
Update theia settings, started on README.md (#3)
* more gitignore, more hiding things * perfect * added to docs * remove DS STORE * ready to merge
1 parent c89ac7c commit c6aacf4

File tree

9 files changed

+5015
-1
lines changed

9 files changed

+5015
-1
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11

22
# Created by https://www.toptal.com/developers/gitignore/api/python
33
# Edit at https://www.toptal.com/developers/gitignore?templates=python
4+
.DS_Store
45

56
### Python ###
67
# Byte-compiled / optimized / DLL files

.theia/settings.json

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,13 @@
99
"editor.rulers": [
1010
88
1111
],
12-
"python.pythonPath": ".venv/bin/python3"
12+
"python.pythonPath": ".venv/bin/python3",
13+
"files.exclude": {
14+
".git": true,
15+
".pytest_cache": true,
16+
".venv": true,
17+
"**/__pycache__": true,
18+
".mypy_cache": true,
19+
"*.egg-info": true
20+
}
1321
}

README.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
<a href="https://github.com/devopslibrary/the-perfect-python-project">
2+
<img src="docs/snake.png" alt="The Perfect Python Project" title="Snake" align="right" height="60" />
3+
</a>
4+
5+
# Perfect Python Project
6+
7+
This project is used to demonstrate my idea of a perfect Python project
8+
configuration. Nearly everthing I've chosen can be bikeshedded for hours or
9+
days, but feel free to submit a PR if you can back up your suggestions with
10+
evidence. 😊
11+
12+
[![Bikeshedding](docs/bikeshed.jpg)](https://en.wiktionary.org/wiki/bikeshedding)
13+
14+
## Prerequisites
15+
16+
(Last updated September 13, 2020)
17+
18+
- Latest version of Python (3.8.5)
19+
- Latest version of Poetry ()
20+
21+
## Installing PyEnv
22+
23+
For installing Python, you should you PyEnv, regardless of operating system. PyEnv will allow you to easily switch versions of Python. In a perfect world, everyone would be on the latest version, but often we don't have the luxury.
24+
25+
### OSX
26+
27+
[(You are using Homebrew right?)](https://brew.sh/ "Package Manager for OSX")
28+
29+
```bash
30+
brew update
31+
brew install pyenv
32+
33+
# Add pyenv to Path
34+
# Or .bashrc,. .bash_profile, etc. if not using ZSH
35+
echo 'export PYENV_ROOT="$HOME/.pyenv"' >> ~/.zshrc
36+
echo 'export PATH="$PYENV_ROOT/bin:$PATH"' >> ~/.zshrc
37+
# Autocompletion, requires shell restart
38+
echo -e 'if command -v pyenv 1>/dev/null 2>&1; then\n eval "$(pyenv init -)"\nfi' >> ~/.zshrc
39+
```
40+
41+
### Windows
42+
43+
## Installing Python
44+
45+
```bash
46+
pyenv install 3.8.5
47+
pyenv global 3.8.5 # Sets python and python3 globally to point to 3.8.5
48+
```

docs/bikeshed.jpg

91.9 KB
Loading

docs/logo.svg

Lines changed: 4957 additions & 0 deletions
Loading

docs/snake.png

93.6 KB
Loading
-162 Bytes
Binary file not shown.
-133 Bytes
Binary file not shown.
Binary file not shown.

0 commit comments

Comments
 (0)