Notes on git, tox, and logging

Author: jonnyg23

Python.md

@@ -68,7 +68,7 @@ pip freeze | xargs pip uninstall -y
 
 - [[pytest]] - Run unit tests
 - [[tox]] - Runs tests with multiple python versions (3.7, 3.8, 3.9, etc)
-- 
+- [[logging]] - Logs info related to warnings, debug, info, & exceptions
 
 
 

git.md

@@ -41,6 +41,233 @@ git branch --delete BRANCH_NAME
 
 - .gitignore command [guide](https://www.atlassian.com/git/tutorials/saving-changes/gitignore)
 
+Here is an example **.gitignore** file:
+
+```
+# Created by https://www.toptal.com/developers/gitignore/api/python,windows,osx
+# Edit at https://www.toptal.com/developers/gitignore?templates=python,windows,osx
+
+### OSX ###
+
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### Python ###
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+  
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+  
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintainted in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file. For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+  
+
+### Windows ###
+
+# Windows thumbnail cache files
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+# End of https://www.toptal.com/developers/gitignore/api/python,windows,osx
+```
+
 
 ## Troubleshooting
 

logging.md

@@ -0,0 +1,67 @@
+---
+tags: 💽
+aliases: 
+  - logging
+cssclass:
+---
+
+# [[logging]]
+
+---
+
+## [[Python]]
+
+### Using logging
+
+In the main python file of repo (such as repo/source/main.py) add the following:
+> ✏️ Note: This can be used in every python file that needs to log data.
+
+```python
+import logging
+
+# Sets up a logger
+logging.basicConfig() # This line is not usually included adding logging to other files
+logger = logging.getLogger(__name__) # Will name the logger the file path
+logger.setLevel(logging.INFO)
+```
+
+OR you can use the below code for more specific logging other than INFO:
+
+```python
+import logging
+
+# Create a logger
+logger = logging.getLogger(__name__)
+logger.setLevel(logging.DEBUG)
+
+# Set up a file handler
+file_handler = logging.FileHandler('app.log')
+file_handler.setLevel(logging.DEBUG)
+
+# Set up a console handler
+console_handler = logging.StreamHandler()
+console_handler.setLevel(logging.INFO)
+
+# Define a formatter
+formatter = logging.Formatter('%(asctime)s - %(levelname)s - %(message)s')
+
+# Add the formatter to the handlers
+file_handler.setFormatter(formatter)
+console_handler.setFormatter(formatter)
+
+# Add the handlers to the logger
+logger.addHandler(file_handler)
+logger.addHandler(console_handler)
+
+# Start logging
+logger.debug('This is a debug message')
+logger.info('This is an info message')
+logger.warning('This is a warning message')
+logger.error('This is an error message')
+logger.critical('This is a critical message')
+
+```
+
+
+
+🔗 Links to this page:

tox.md

@@ -12,6 +12,61 @@ cssclass:
 ---
 > [Tox Docs](https://tox.wiki/en/latest/example/basic.html)
 
+## Installation
+
+```bash
+pip install tox
+
+# Use this if you want use tox with already created virtual environment
+pip install tox tox-current-env
+```
+
+## Example of tox.ini
+
+> **RUN WITH:** 
+> `tox` (Creates new virtual environment to execute tox)
+> `tox --current-env`  (Uses already created *.venv* for running tox) **Must have `tox-current-env` installed**
+
+This generic tox report will use [[Python]] 3.9. It will perform the following:
+- Ignore venv and tox directories
+- Execute flake8, pytest, isort, and black linting & testing error checks
+```ini
+[tox]
+envlist = py39
+ignore = .tox/*,.venv/*
+
+[testenv]
+commands =
+    flake8 --exclude .tox,.venv --extend-ignore=E501
+    pytest
+	isort . --skip .tox --skip .venv
+	black .
+deps =
+	pytest
+	flake8
+	isort
+	black
+
+[testenv:flake8]
+commands =
+	flake8 --exclude .tox,.venv --extend-ignore=E501
+deps =
+	flake8
+
+[testenv:isort]
+commands =
+	isort . --skip .tox --skip .venv
+deps =
+	isort
+
+[testenv:fix]
+commands =
+	black --diff --quiet .
+deps =
+	black
+```
+
+
 ## Steps to Set Up
 
 - Create **tox.ini** file at same level as repo's **setup.py**