Merge pull request #3 from praisetompane-programming-languages/docs_clean_up

docs: clean up docs and add spellcheck

Author: praisetompane

.github/workflows/python.yaml

@@ -0,0 +1,19 @@
+name: python
+
+on: 
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Clone Repository
+      uses: actions/checkout@v4
+
+    - name: Spell Check
+      uses: rojopolis/spellcheck-github-actions@0.45.0
+      with:                                        
+        output_file: spellcheck-output.txt

.spellcheck_exceptions_dictionary.txt

@@ -0,0 +1,101 @@
+# acronyms
+CRLF
+LF
+DLR
+DETENT
+DEDENT
+REPL
+BNF
+UTF
+
+
+# authors
+Rossum
+
+
+# domain specific
+radix
+bytecode
+whitespace
+formfeeds
+formfeed
+encodings
+codecs
+namespace
+pycache
+IndentationError
+TabError
+SyntaxError
+datamodel
+coroutines
+lexemes
+lexically
+NFKC
+classname
+dunder
+bitwise
+executionmodel
+
+# python keywords
+pprint
+stdtypes
+builtins
+str
+eval
+repr
+elif
+nonlocal
+async
+formatspec
+sys
+iterable
+init
+
+
+# technology:
+JVM
+pyspelling
+pytest
+svg
+yaml
+numpy
+distutils
+ensurepip
+setuptools
+venv
+pipenv
+
+
+# institutions:
+pypa
+pypi
+hackerrank
+roadmap
+
+
+# urls:
+src
+txt
+py
+devguide
+edu
+modindex
+img
+ccec
+eb
+Aq
+Bstatus
+Pze
+ocw
+piNY
+psf
+tzYhv
+https
+
+
+# pythons implementations:
+CPython
+IronPython
+jython
+pypy
+pythonnet

Dockerfile

@@ -1,7 +1,13 @@
-FROM mcr.microsoft.com/devcontainers/python:1-3.12-bullseye
+FROM python:3.11
 
 WORKDIR /python
 
 COPY . .
 
-RUN pipenv install
+RUN apt-get update \
+    && apt-get install aspell -y
+    
+RUN python -m pip install -r requirements.txt
+
+RUN adduser -u 5678 --disabled-password --gecos "" python && chown -R python /python
+USER python

Pipfile

@@ -1,22 +1,28 @@
 # Python
 
-**objective**: an in-depth study of Python, its implementation and ecosystem.
-
+**objective**: 
+  - An in-depth study of Python's implementation and ecosystem.
+  - This focuses on [CPython](https://github.com/python/cpython).
+  
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 
 ## Language Details: 
   - [language reference](https://docs.python.org/3.11/reference/index.html#reference*index)
   - [base modules index](https://docs.python.org/3/py-modindex.html)
   - [standard library reference](https://docs.python.org/3.11/library/index.html)
   - [packaging and distribution](https://packaging.python.org/en/latest/)
+    - [python packaging authority](https://www.pypa.io/en/latest/)
+    - [glossary](https://packaging.python.org/en/latest/glossary/)
     - tools:
       - [pip](https://pypi.org/project/pip/)
       - [pipenv](https://pipenv.pypa.io/en/latest/)
     - structuring projects:
   - [package index](https://pypi.org)
   - [extending and embedding](https://docs.python.org/3.11/extending/index.html)
   - [developer contribution guide](https://devguide.python.org/)
-  - [compiler/interpreter](https://github.com/python/cpython)
+  - compiler/interpreter:
+    - [cpython implementation](https://github.com/python/cpython)
+      - [Bennett, J. 2019. See CPython run: Getting to know your Python interpreter. North Bay Python](https://www.youtube.com/watch?v=tzYhv61piNY)
   - memory model:
     - [computational complexity cost model](https://ocw.mit.edu/courses/6-006-introduction-to-algorithms-fall-2011/pages/readings/python-cost-model/)
   - history:
@@ -32,6 +38,11 @@
   - [roadmap](https://roadmap.sh/python)
   - [practice problems](https://www.hackerrank.com/domains/python?filters%5Bstatus%5D%5B%5D=unsolved&badge_type=python)
 
+## Spell Check:
+
+```shell
+pyspelling -c spellcheck.yaml
+```
 
 # References:
 

Pipfile.lock

@@ -0,0 +1,3 @@
+-i https://pypi.org/simple
+numpy==2.2.3; python_version >= '3.10'
+pyspelling==2.10

README.md

@@ -1,26 +1,26 @@
-echo "adding asdf python plugin"
+echo "Adding asdf python plugin"
     asdf plugin add python
-echo "done"
+echo "Done"
 
 ostype="$(uname -s)"
 if [ "$ostype" = "Linux" ]; then
-    echo "install openssl dependecy"
+    echo "install openssl dependency"
     sudo apt install libedit-dev
-    echo "done"
+    echo "Done"
 fi
 
-echo "installing python"
+echo "Installing python"
     asdf install python latest
-echo "done"
+echo "Done"
 
-echo "set latest version to system wide version"
+echo "Set latest version to system wide version"
     asdf global python latest
-echo "done"
+echo "Done"
 
-echo "installing pipenv"
+echo "Installing pipenv"
     brew install pipenv
-echo "done"
+echo "Done"
 
 echo "installing system level Black in python"
     pip3 install black
-echo "done"
+echo "Done"

dictionary.dic

@@ -0,0 +1,14 @@
+matrix:
+  - name: All Files
+    aspell:
+      lang: en
+      ignore-case: false
+    dictionary:
+      wordlists:
+        - .spellcheck_exceptions_dictionary.txt
+      encoding: utf-8
+    sources:
+      - "**/*.md"
+      - "**/*.tex"
+      - "**/*.txt"
+    default_encoding: utf-8