Skip to content

Commit 944fbb5

Browse files
committed
more docs updating
1 parent c6aacf4 commit 944fbb5

File tree

8 files changed

+197
-40
lines changed

8 files changed

+197
-40
lines changed

.vscode/settings.json

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
{
2+
"files.exclude": {
3+
"**/.DS_Store": true,
4+
"**/__pycache__/": true,
5+
"**/*.py[cod]": true,
6+
"**/*$py.class": true,
7+
"**/*.so": true,
8+
"**/.Python": true,
9+
"**/build/": true,
10+
"**/develop-eggs/": true,
11+
"**/dist/": true,
12+
"**/downloads/": true,
13+
"**/eggs/": true,
14+
"**/.eggs/": true,
15+
"**/lib/": true,
16+
"**/lib64/": true,
17+
"**/parts/": true,
18+
"**/sdist/": true,
19+
"**/var/": true,
20+
"**/wheels/": true,
21+
"**/pip-wheel-metadata/": true,
22+
"**/share/python-wheels/": true,
23+
"**/*.egg-info/": true,
24+
"**/.installed.cfg": true,
25+
"**/*.egg": true,
26+
"**/MANIFEST": true,
27+
"**/*.manifest": true,
28+
"**/*.spec": true,
29+
"**/pip-log.txt": true,
30+
"**/pip-delete-this-directory.txt": true,
31+
"**/htmlcov/": true,
32+
"**/.tox/": true,
33+
"**/.nox/": true,
34+
"**/.coverage": true,
35+
"**/.coverage.*": true,
36+
"**/.cache": true,
37+
"**/nosetests.xml": true,
38+
"**/coverage.xml": true,
39+
"**/*.cover": true,
40+
"**/*.py,cover": true,
41+
"**/.hypothesis/": true,
42+
"**/.pytest_cache/": true,
43+
"**/pytestdebug.log": true,
44+
"**/*.mo": true,
45+
"**/*.pot": true,
46+
"**/*.log": true,
47+
"**/local_settings.py": true,
48+
"**/db.sqlite3": true,
49+
"**/db.sqlite3-journal": true,
50+
"**/instance/": true,
51+
"**/.webassets-cache": true,
52+
"**/.scrapy": true,
53+
"**/docs/_build/": true,
54+
"**/doc/_build/": true,
55+
"**/target/": true,
56+
"**/.ipynb_checkpoints": true,
57+
"**/profile_default/": true,
58+
"**/ipython_config.py": true,
59+
"**/.python-version": true,
60+
"**/__pypackages__/": true,
61+
"**/celerybeat-schedule": true,
62+
"**/celerybeat.pid": true,
63+
"**/*.sage.py": true,
64+
"**/.env": true,
65+
"**/.venv": true,
66+
"**/env/": true,
67+
"**/venv/": true,
68+
"**/ENV/": true,
69+
"**/env.bak/": true,
70+
"**/venv.bak/": true,
71+
"**/.spyderproject": true,
72+
"**/.spyproject": true,
73+
"**/.ropeproject": true,
74+
"site": true,
75+
"**/.mypy_cache/": true,
76+
"**/.dmypy.json": true,
77+
"**/dmypy.json": true,
78+
"**/.pyre/": true,
79+
"**/.pytype/": true,
80+
".pytest_cache/**/*": true
81+
}
82+
}

README.md

Lines changed: 42 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
</a>
44

55
# Perfect Python Project
6-
6+
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/aws/aws-cdk)
77
This project is used to demonstrate my idea of a perfect Python project
88
configuration. Nearly everthing I've chosen can be bikeshedded for hours or
99
days, but feel free to submit a PR if you can back up your suggestions with
@@ -18,9 +18,11 @@ evidence. 😊
1818
- Latest version of Python (3.8.5)
1919
- Latest version of Poetry ()
2020

21-
## Installing PyEnv
21+
## Install PyEnv
2222

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.
23+
For installing Python, you should you PyEnv, regardless of operating system.
24+
PyEnv will allow you to easily switch versions of Python. In a perfect world,
25+
everyone would be on the latest version, but often we don't have the luxury.
2426

2527
### OSX
2628

@@ -29,20 +31,49 @@ For installing Python, you should you PyEnv, regardless of operating system. PyE
2931
```bash
3032
brew update
3133
brew install pyenv
34+
echo 'export PYENV_ROOT="$HOME/.pyenv"' >> ~/.zshrc # Add pyenv to Path
35+
echo 'export PATH="$PYENV_ROOT/bin:$PATH"' >> ~/.zshrc # Or .bashrc,. .bash_profile, etc. if not using ZSH
36+
echo -e 'if command -v pyenv 1>/dev/null 2>&1; then\n eval "$(pyenv init -)"\nfi' >> ~/.zshrc # Autocompletion, requires shell restart
37+
```
3238

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+
### Windows PowerShell
40+
[(You are using Chocolatey right?)](https://chocolatey.org/ "Package Manager for Windows")
41+
**NOTE: ** You should just move to WSL, trust me, the sooner you do it the better everything will be. :)
42+
```powershell
43+
choco install pyenv-win
44+
# Restart PowerShell
45+
pyenv update # To get the latest versions of Python, otherwise you won't see 3.8.5
46+
```
47+
48+
### Linux, Windows WSL
49+
```bash
50+
git clone https://github.com/pyenv/pyenv.git ~/.pyenv
51+
echo 'export PYENV_ROOT="$HOME/.pyenv"' >> ~/.zshrc # Add pyenv to Path
52+
echo 'export PATH="$PYENV_ROOT/bin:$PATH"' >> ~/.zshrc # Or .bashrc,. .bash_profile, etc. if not using ZSH
53+
echo -e 'if command -v pyenv 1>/dev/null 2>&1; then\n eval "$(pyenv init -)"\nfi' >> ~/.zshrc # Autocompletion, requires shell restart
3954
```
4055

41-
### Windows
4256

43-
## Installing Python
57+
## Install Python
58+
Time to install the latest version of Python!
4459

4560
```bash
4661
pyenv install 3.8.5
4762
pyenv global 3.8.5 # Sets python and python3 globally to point to 3.8.5
63+
# Let's verify 3.8.5 is set globally, close whatever terminal you are using, then run:
64+
python --version # This should say 3.8.5, great job!
4865
```
66+
67+
## Install Poetry
68+
Poetry is a fantastic package manager for Python.
69+
70+
### OSX, Linux, Windows WSL
71+
```bash
72+
curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python
73+
echo 'source $HOME/.poetry/env' >> ~/.zshrc
74+
```
75+
76+
### Windows PowerShell
77+
```powershell
78+
(Invoke-WebRequest -Uri https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py -UseBasicParsing).Content | python
79+
```

poetry.lock

Lines changed: 55 additions & 20 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)