chore: py gitignore for venv and other parts and adding simple formatter via pre-commi config

onuralpszr · onuralpszr · commit 14886d8bf837 · 2024-08-29T22:35:30.000+03:00
Signed-off-by: Onuralp SEZER &lt;thunderbirdtr@gmail.com&gt;
diff --git a/.github/workflows/pdf.yml b/.github/workflows/pdf.yml
@@ -22,4 +22,3 @@ jobs:
         with:
           name: lesson-plan.pdf
           path: ./site/lesson-plan.pdf
-
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,162 @@
+# 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
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__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 maintained 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/
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,23 @@
+
+ci:
+  autofix_prs: true
+  autoupdate_schedule: weekly
+  autofix_commit_msg: "fix(pre_commit): 🎨 auto format pre-commit hooks"
+  autoupdate_commit_msg: "chore(pre_commit): ⬆ pre_commit autoupdate"
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: trailing-whitespace
+      - id: check-yaml
+        exclude: mkdocs.yml
+      - id: check-executables-have-shebangs
+      - id: check-toml
+      - id: check-case-conflict
+      - id: check-added-large-files
+      - id: detect-private-key
+      - id: pretty-format-json
+        args: ['--autofix', '--no-sort-keys', '--indent=4']
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
diff --git a/README.md b/README.md
@@ -16,7 +16,7 @@ The current build of the  PDF is avaliable in GitHub Actions. Visit https://gith
 5. You can now build the PDF document locally by running `ENABLE_PDF_EXPORT=1 pipenv run mkdocs build`
 
 ## Editing the sources
-Place new documents in the `/docs` directory using markdown files. 
+Place new documents in the `/docs` directory using markdown files.
 You can see your changes by running `ENABLE_PDF_EXPORT=1 pipenv run`.
 Once you're ready to propose your changes, make a PR to this repo. [Material for mkdocs](https://squidfunk.github.io/mkdocs-material/), [mkdocs](https://www.mkdocs.org/user-guide/writing-your-docs/) and [mkdocs with PDF](https://pypi.org/project/mkdocs-with-pdf/) documentation could also be useful.
 
diff --git a/docs/benefits-of-open-source-software.md b/docs/benefits-of-open-source-software.md
@@ -23,8 +23,8 @@
 * What the Internet Bug Bounty Teaches About Open-Source Software Security (<https://securityintelligence.com/articles/open-source-software-security-bug-bounty/>)
 * Choosing a License (<https://opensource.guide/starting-a-project/#choosing-a-license>)
 * Why do people open source their work? (<https://opensource.guide/starting-a-project/#why-do-people-open-source-their-work>)
-* How to Join an Open Source Community - <https://youtu.be/XyHSPjU2h10> 
-* Free Software or Open Source Software? Is There A Difference? - <https://youtu.be/Qyb5KZC7d6s> 
+* How to Join an Open Source Community - <https://youtu.be/XyHSPjU2h10>
+* Free Software or Open Source Software? Is There A Difference? - <https://youtu.be/Qyb5KZC7d6s>
 
 ## Extra Credit
 * Explain what <https://smile.amazon.com/> is about in less than 250 words.
@@ -40,15 +40,13 @@
 
 ## Evaluations
 * Does the student understand the concepts and objectives listed above?
-* Can the student communicate two benefits of why companies and developers choose free and open-source software? 
+* Can the student communicate two benefits of why companies and developers choose free and open-source software?
 * Can the student explain the advantages for the user of free and open-source software?
 * What are the benefits of open source standards and software to society?
 * Did the student contribute to an open-source project during this lesson.
 
 ## Notes:
-* Advance levels can view and discuss the following resources: EU Study about Open Source Impact - <https://digital-strategy.ec.europa.eu/en/library/study-about-impact-open-source-software-and-hardware-technological-independence-competitiveness-and> 
+* Advance levels can view and discuss the following resources: EU Study about Open Source Impact - <https://digital-strategy.ec.europa.eu/en/library/study-about-impact-open-source-software-and-hardware-technological-independence-competitiveness-and>
 * Presentation about results - <https://www.youtube.com/watch?v=ujp2dsfyOuQ>
 * The Linux Foundation panel about it - https://www.youtube.com/watch?v=gLLCYQSkcT4&list=PLbzoR-pLrL6q8QMGJ4dFnqejkHDm76kJV&index=193
 * Digital infrastructure is more than just broadband: What the US can learn from Europe’s open source technology policy study - <https://www.brookings.edu/research/digital-infrastructure-is-more-than-just-broadband-what-the-u-s-can-learn-from-europes-open-source-technology-policy-study/>
-
-
diff --git a/docs/installing-opensuse.md b/docs/installing-opensuse.md
@@ -21,7 +21,7 @@
 * “openSUSE: A Beautiful Linux Distro” video at <https://youtu.be/yf3b6b1iHIA>
 * “openSUSE Leap 15.2 | Review and Final Thoughts” video at <https://youtu.be/wP4IvrsdZZo>
 * Installable images at <https://get.opensuse.org/>
-* Rolling vs. Point Release Linux Distros – Which is better? <https://www.fosslinux.com/2805/linux-rolling-release-vs-point-release-and-which-is-better.htm> 
+* Rolling vs. Point Release Linux Distros – Which is better? <https://www.fosslinux.com/2805/linux-rolling-release-vs-point-release-and-which-is-better.htm>
 * Image1 - <https://en.wikipedia.org/wiki/Software_release_life_cycle#/media/File:Software_dev2.svg>
 * Burning ISO images with [Ventoy](https://www.ventoy.net/en/doc_start.html) and [Etcher](https://www.balena.io/etcher/)
 
@@ -32,12 +32,12 @@
 * Watch [openSUSE: A Beautiful Linux Distro](https://youtu.be/yf3b6b1iHIA) as a class the to understand how to download and install openSUSE. Discuss the differences between Tumbleweed and Leap.
 * Watch the first 4 minutes of [openSUSE Leap 15.2 | Review and Final Thoughts](https://youtu.be/wP4IvrsdZZo) and discuss the reasons for selecting different types of software options.
 * Download an image of openSUSE from; https://get.opensuse.org/
-* Use a USB/microUSB and application/commands of your choice to write an image 
+* Use a USB/microUSB and application/commands of your choice to write an image
 * Have students read and discuss [Rolling vs. Point Release Linux Distros – Which is better?](https://www.fosslinux.com/2805/linux-rolling-release-vs-point-release-and-which-is-better.htm)
 
 ## Evaluations
 * Does the student understand the concepts and objectives listed above?
-* Did the student download and install openSUSE? 
+* Did the student download and install openSUSE?
 * Can the student explain the advantages for the user of free and open-source software?
 * What are the benefits of open source standards and software to society?
 * Did the student contribute to an open-source project during this lesson?
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -24,4 +24,3 @@ plugins:
       output_path: ./lesson-plan.pdf
       toc_title: Contents
       back_cover: false
-
diff --git a/requirements.txt b/requirements.txt
@@ -2,4 +2,3 @@ mkdocs-material-extensions
 mkdocs-material
 mkdocs-with-pdf
 mkdocs
-
