version 0.1, implementation of some features with priority label

.github/workflows/pytest.yaml

@@ -0,0 +1,33 @@
+name: MYPY TYPE CHECK
+
+on:
+  push:
+    branches: [ "devel" ]
+  pull_request:
+    branches: [ "main", "devel" ]
+
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11"]
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install mypy==0.991
+        if [ -f REQUIREMENTS ]; then pip install -r REQUIREMENTS; fi
+        if [ -f DEV_REQUIREMENTS ]; then pip install -r DEV_REQUIREMENTS; fi
+    - name: Run mypy type check
+      run: |
+        mypy --strict $(git ls-files "*.py") --explicit-package-base
+      working-directory: .

CODE_OF_CONDUCT.md

@@ -11,18 +11,21 @@ include:
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or
-  advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
+* The use of sexualized language or imagery and unwelcome sexual
+attention or advances
+* Trolling, insulting/derogatory comments, and personal or political
+attacks
 * Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
+* Publishing others' private information, such as a physical or
+electronic address, without explicit permission
 * Other conduct which could reasonably be considered inappropriate in a
-  professional setting
+professional setting
 
 ## Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+This Code of Conduct is adapted from the
+[Contributor Covenant][homepage], version 1.4,
+available at
+https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
 
 [homepage]: https://www.contributor-covenant.org

CONTRIBUTING.md

@@ -1,23 +1,22 @@
 # Contribution
 
-All pull requests are welcome, however, do note that the maintainer of the
-project is a full time university student, thus may not be able to respond as
-fast as you may expect.
+All pull requests are welcome, however, do note that the maintainer of
+the project is a full time university student, thus may not be able to
+respond as fast as you may expect.
 
 # Notes
 
-1. If you are planning to introduce a big change in codebase, open an issue
-first for discussion, that waste of time would be avoided.
+1. If you are planning to introduce a big change in codebase, open an
+issue first for discussion, that waste of time would be avoided.
 
-2. The project is currently written in Python 3.10, with strict compliance to
-[PEP-0008](https://peps.python.org/pep-0008/) in terms of formatting, and to
-[PEP-0257](https://peps.python.org/pep-0257/) in regards of docstring
-formatting, with slight modification for sake of consistency:
+2. The project is currently written in Python 3.10, with strict
+compliance to [PEP-0008](https://peps.python.org/pep-0008/) in terms of
+formatting, and to [PEP-0257](https://peps.python.org/pep-0257/) in
+regards of docstring formatting, with slight modification for sake of
+consistency. The modifications include:
 
-The modifications include:
-
-In lists, as well as declaration of variables, there is always indent after
-line break:
+In lists, as well as declaration of variables, there is always indent
+after line break:
 
 ```python
 hello_world: list[str] = [
@@ -39,11 +38,14 @@ hello_from_long_function(
 )
 ```
 
-Rules to type checking is provided by [PEP-0484](https://peps.python.org/pep-0484/),
-and is checked by [`mypy`](https://github.com/python/mypy), which requires
+Moreover, the project strictly requires lines to be limited to 72 chars.
+
+Rules to type checking is provided by
+[PEP-0484](https://peps.python.org/pep-0484/), and is checked by
+[`mypy`](https://github.com/python/mypy), which requires
 `type-setuptools` and `type-requests`.
 
-3. Be sure to run the checks and test your code first before opening pull
-requests, the unit test can be invoked with `./check.sh`.
+3. Be sure to run the checks and test your code first before opening
+pull requests, the unit test can be invoked with `./check.sh`.
 
 4. Always comply to [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md).

DEV_REQUIREMENTS

@@ -0,0 +1,3 @@
+mypy==0.991
+types-requests==2.28.11.7
+types-psutil==5.9.5.6

HACKING.md

@@ -1,7 +1,8 @@
 # HACKING
 
-To setup the project, clone the `devel` branch of the repository and create
-your own branch with the name of feature/issue you want to introduce/work on:
+To setup the project, clone the `devel` branch of the repository and
+create your own branch with the name of feature/issue you want to
+introduce/work on:
 
 ```
 git clone -b devel https://github.com/iaacornus/Fedora-OSTree-Setup
@@ -13,16 +14,16 @@ Then
 git branch <name-of-branch>
 ```
 
-The project is using Python >= 3.10, preferrably 3.11, thus to start working on
-check if you have Python >= 3.10 with:
+The project is using Python >= 3.10, preferrably 3.11, thus to start
+working on check if you have Python >= 3.10 with:
 
 ```
 python --version
 ```
 
-Although there can be workarounds, it is encouraged to use Python 3.10, but if not
-possible, it is not enforced, upto Python >= 3.7 is acceptable. Then create a
-virtual environment with
+Although there can be workarounds, it is encouraged to use Python 3.10,
+but if not possible, it is not enforced, upto Python >= 3.7 is
+acceptable. Then create a virtual environment with
 
 ```
 python -m venv venv
@@ -34,21 +35,22 @@ Source it and start installing dependencies with
 pip install -r DEV_REQUIREMENTS && pip install -r REQUIREMENTS
 ```
 
-_Note that in other system `pip3` or `pip<python-version>` is used instead,
-e.g. `pip3.11`._
+_Note that in other system `pip3` or `pip<python-version>` is used
+instead, e.g. `pip3.11`._
 
-`DEV_REQUIREMENTS` include the modules needed for test, specifically `mypy` and
-the `types` of other third party modules, while `REQUIREMENTS` contains the
-modules used by project.
+`DEV_REQUIREMENTS` include the modules needed for test, specifically
+`mypy` and the `types` of other third party modules, while
+`REQUIREMENTS` contains the modules used by project.
 
-Finally start working in the project, refer to [CONTRIBUTING.md](CONTRIBUTING.md)
-for guidelines about code formatting and [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)
-for acceptable interactions with in the community.
+Finally start working in the project, refer to
+[CONTRIBUTING.md](CONTRIBUTING.md) for guidelines about code formatting
+and [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) for acceptable
+interactions with in the community.
 
 # Notes
 
-1. All functions are documented with docstrings, [PEP 0257](https://peps.python.org/pep-0257/),
-which takes a format of:
+1. All functions are documented with docstrings,
+[PEP 0257](https://peps.python.org/pep-0257/), which takes a format of:
 
 ```python
 def function(x: int) -> int:
@@ -73,7 +75,7 @@ def function(x: int) -> int:
     return x*x
 ```
 
-2. Use comments, preferrably if you can use the Better Comments syntax, please do:
+2. Use comments, preferrably if you can use the Better Comments syntax:
 
 ```
 #! FOR URGENT/WARNING
@@ -82,4 +84,5 @@ def function(x: int) -> int:
 # TODO: THINGS THAT SHOULD BE DONE
 ```
 
-
+3. Browse `/docs/` for further documentation of the project structure,
+functions, classes and the code itself.

INSTALLATION.md

@@ -0,0 +1,27 @@
+# Installation
+
+**The project is currently in active development**
+
+The project is written in Python >= 3.11, and does not need to be
+compiled however, the dependencies are needed to be installed in a
+`$PATH` accessible by python.
+
+The authors recommend to install the project dependencies inside
+virtualbox and test the project inside:
+
+```
+python3.11 -m venv venv
+```
+
+Then activate the virtual environment, and install the dependencies
+with:
+
+```
+python3.11 -m pip install -r REQUIREMENTS
+```
+
+And run the main module:
+
+```
+python -m src.main
+```

README.md

@@ -1,2 +1,14 @@
 # Fedora-OSTree-Setup
-A small program making the install of Fedora Silverblue / Kionite easy. It lets you choose what to install or set.
+
+A python-program that automates the setup of Fedora Silverblue/Kinoite
+based on given config file.
+
+# Contributing
+
+All contributions whether small or large is welcome! Just fork the
+project and create a pull request when done.
+
+Refer to [HACKING.md](HACKING.md) to start in how to setup the project,
+then in [CONTRIBUTING.md](CONTRIBUTING.md) for protocols/guidelines to
+follow, and take a browse in [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)
+to see what is the acceptable behavior in the community.

REQUIREMENTS

@@ -0,0 +1,4 @@
+rich==12.6.0
+requests==2.28.1
+psutil==5.9.4
+blkinfo==0.2.0