Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
253 commits
Select commit Hold shift + click to select a range
3dc4759
core subpackage
iaacornus Dec 24, 2022
d5c7fd8
shared subpackage
iaacornus Dec 24, 2022
a223cda
misc and interface subpackage
iaacornus Dec 24, 2022
f9786a4
module to simplify user input
iaacornus Dec 24, 2022
245daf7
module for execution or system calls
iaacornus Dec 24, 2022
a8db4ec
include case for string/char input
iaacornus Dec 24, 2022
2a67120
rename the folder and the file log name
iaacornus Dec 24, 2022
eb1c135
for fetching of environment variable
iaacornus Dec 24, 2022
8302678
commandline interface
iaacornus Dec 24, 2022
7d84cd1
for package related data
iaacornus Dec 24, 2022
cb7d4c1
dataclass for unused apps
iaacornus Dec 24, 2022
920a34e
dataclass of the apps to be installed
iaacornus Dec 24, 2022
5ce4486
for developers
iaacornus Dec 24, 2022
ea9d04e
for checking of type annotations
iaacornus Dec 24, 2022
c78901f
update permissions
iaacornus Dec 25, 2022
95832fb
include descriptions for app
iaacornus Dec 25, 2022
88a9b90
module for checking the gpu in the system
iaacornus Dec 25, 2022
d6c1078
Merge branch 'main' of https://github.com/iaacornus/Fedora-OSTree-Set…
iaacornus Dec 25, 2022
036d40b
handle file not found exception when the command executable is not found
iaacornus Dec 25, 2022
5a34348
update the return output for easier parsing
iaacornus Dec 25, 2022
c039c96
include clamtk and flatseal
iaacornus Dec 25, 2022
2faca7a
parse the return value for the gpu name
iaacornus Dec 25, 2022
aa3aecd
fix type annotation for function return
iaacornus Dec 25, 2022
24df965
EXPERIMENTAL: module to determine the appropriate gpu based on lspci …
iaacornus Dec 25, 2022
f48ae95
initial commit for third repo install #6
iaacornus Dec 25, 2022
f4d2f89
Update ToDo.md
boredsquirrel Dec 25, 2022
09bd35e
added zenity gui notification example
boredsquirrel Dec 25, 2022
807a605
java and perl as options
boredsquirrel Dec 25, 2022
11f86b4
Merge pull request #8 from trytomakeyouprivate/patch-3
iaacornus Dec 26, 2022
4cdc811
Merge pull request #10 from trytomakeyouprivate/patch-5
iaacornus Dec 26, 2022
4ab0f10
Merge branch 'main' into patch-4
iaacornus Dec 26, 2022
8027354
Merge pull request #9 from trytomakeyouprivate/patch-4
iaacornus Dec 26, 2022
9ae6e65
for installation of third party repo #6
iaacornus Dec 27, 2022
be73995
initial commit for #11
iaacornus Dec 27, 2022
24f0656
use json instead of python dataclasses
iaacornus Dec 27, 2022
8abde03
move the list of apps for install in app_for_install.json
iaacornus Dec 27, 2022
b12cb99
deprecate data subpackage
iaacornus Dec 27, 2022
a7f5e25
lists of unnecessary preinstalled flatpak applications that can be re…
iaacornus Dec 27, 2022
132fbb2
Merge branch 'main' of https://github.com/iaacornus/Fedora-OSTree-Set…
iaacornus Dec 27, 2022
f034cad
append requests 2.28.1
iaacornus Dec 27, 2022
8660ccd
for fetching of config file from github
iaacornus Dec 27, 2022
d91ceae
move to conf subsubpackage
iaacornus Dec 27, 2022
acff7be
rename conf to conf_name
iaacornus Dec 27, 2022
4afb561
for parsing and checking of config file
iaacornus Dec 27, 2022
e156849
cleanup and update todo
iaacornus Dec 27, 2022
221268d
link issue tracker for feature in development
iaacornus Dec 27, 2022
add421e
include the applications suggestion in #7
iaacornus Dec 29, 2022
a2ebd83
Merge branch 'devel' of https://github.com/iaacornus/Fedora-OSTree-Se…
iaacornus Dec 29, 2022
9a4f042
include comment informing about the blank value for conf_link
iaacornus Dec 30, 2022
33eb107
remove unused variable conf
iaacornus Dec 30, 2022
bd3c623
use dictionary to hold the links of different configs
iaacornus Dec 30, 2022
c463817
include \`.json\` in the name of the downloaded config
iaacornus Dec 30, 2022
6aa060b
fix conditions
iaacornus Dec 30, 2022
9ca7ca1
fix bug
iaacornus Dec 30, 2022
d0a2af9
include documentation for the conf class
iaacornus Dec 30, 2022
9460995
initial commit in cli of program
iaacornus Dec 30, 2022
6e0f330
initial commit for uninstallation of preinstalled apps #11
iaacornus Dec 30, 2022
6befbd4
replaced old cold to use execute_command() form src.utils.shared.exec
iaacornus Dec 30, 2022
a2b7667
include break_proc parameter to avoid raising systemexit by default
iaacornus Jan 1, 2023
b815586
update parameter and arguments
iaacornus Jan 1, 2023
868c4a7
update function documentation
iaacornus Jan 1, 2023
dcc5e07
remove no return annotation
iaacornus Jan 1, 2023
c2f6af9
include --explicit-package-bases argument to mypy
iaacornus Jan 1, 2023
3d72089
rename into -> repo in for loop
iaacornus Jan 1, 2023
4ef1c12
include mypy --install-types
iaacornus Jan 1, 2023
cd7d3ec
fix mypy errors
iaacornus Jan 1, 2023
fb95f99
update mypy version to 0.991
iaacornus Jan 1, 2023
ee1a8ae
github workflow
iaacornus Jan 1, 2023
d596624
rename workflow to mypy type check
iaacornus Jan 1, 2023
847d1ce
include types for requests==2.28
iaacornus Jan 1, 2023
edfe6e9
manually install the types instead of mypy --install-types
iaacornus Jan 1, 2023
cd3cdf6
rename simple_description -> sdesc
iaacornus Jan 1, 2023
9a433c5
use list instead of dictionary for lists of flatpak apps to uninstall
iaacornus Jan 1, 2023
4d58225
restructure utils package
iaacornus Jan 1, 2023
aa1acb8
update imports
iaacornus Jan 1, 2023
76df02c
for installation of recommended applications
iaacornus Jan 1, 2023
f76ae0a
modify the return value of case 2 to return list[int]
iaacornus Jan 1, 2023
f43c2de
for title banner to separate major operations
iaacornus Jan 1, 2023
ee7b48c
capitalize the banner text and uppercase the banner title
iaacornus Jan 1, 2023
e7bc6af
use title banner instead of manual display
iaacornus Jan 1, 2023
9d673b0
update function parameter documentation
iaacornus Jan 1, 2023
31bfabc
organize shared subpackage
iaacornus Jan 1, 2023
6cf5a4e
update imports
iaacornus Jan 1, 2023
81040c8
call .strip() method on return of case 3
iaacornus Jan 1, 2023
11a8c5b
remove unnecessary break_proc parameter
iaacornus Jan 1, 2023
3cfa4a1
use list instead of tuple argument in Popen()
iaacornus Jan 1, 2023
916f8df
convert to class for easier organization
iaacornus Jan 1, 2023
62a2ec1
fix mypy errors
iaacornus Jan 1, 2023
51bca20
rename to separate the lists for flatpak and rpm
iaacornus Jan 3, 2023
34281e9
specify flatpak in name to avoid getting confused with rpm
iaacornus Jan 3, 2023
19a4b65
for installation of recommended rpm applications #13
iaacornus Jan 3, 2023
fd60e27
removal of some base packages #11
iaacornus Jan 3, 2023
6d3e3f4
use dictionary instead of array
iaacornus Jan 3, 2023
8cbeb10
use dictionary instead of array
iaacornus Jan 3, 2023
fcf1e7b
removed sdesc completely
iaacornus Jan 3, 2023
1555738
remove aid and simply use a key-value pair of app-name: app id
iaacornus Jan 3, 2023
7282c73
update links and name of files in config list
iaacornus Jan 3, 2023
44ff6cb
rename third_repo_install -> tp_repo_install
iaacornus Jan 3, 2023
435eead
include gnome-nightly, kde, and fedora oci in third repo installs #6
iaacornus Jan 3, 2023
5bf6340
replace capitalize() with upper()
iaacornus Jan 3, 2023
09ece42
remove repititive lines
iaacornus Jan 3, 2023
b29e9f1
create new type aliases to avoid long and confusing annotations
iaacornus Jan 4, 2023
6a719f1
replace long and confusing annotations with new types
iaacornus Jan 4, 2023
e523cf6
wrong file
iaacornus Jan 4, 2023
f6df5f2
update imports
iaacornus Jan 4, 2023
ff5a33a
move the iteration of the appdata in _enum_apps()
iaacornus Jan 4, 2023
39cb456
create alias instead of new type
iaacornus Jan 4, 2023
508fd93
update annotations
iaacornus Jan 4, 2023
52ce004
use aid instead of name for consistency
iaacornus Jan 4, 2023
21b38a5
do separate iteration for flatpak and rpm
iaacornus Jan 4, 2023
e6853d5
append the flatpak install command instead
iaacornus Jan 4, 2023
d60587d
include --assumeyes argument in flatpak installation
iaacornus Jan 4, 2023
93436c0
update links
iaacornus Jan 4, 2023
877f347
create a more informative log msg
iaacornus Jan 4, 2023
40f69e7
configvalue alias
iaacornus Jan 4, 2023
a1e1cb4
create a more informative log msg and use type alias
iaacornus Jan 4, 2023
af749aa
include documentation for flatpak_cmd_list
iaacornus Jan 4, 2023
eee48c4
return an array instead of calling exec_cmd function
iaacornus Jan 4, 2023
8add883
rename the command to exec_cmd
iaacornus Jan 4, 2023
f4141fe
avoid taking the true array as parameter to the function
iaacornus Jan 4, 2023
e794062
prefix t_ to temporary for distinction
iaacornus Jan 4, 2023
530ffec
rename variables
iaacornus Jan 4, 2023
7cb7bbb
return an array of appropriate gpu drvs
iaacornus Jan 4, 2023
c8dc21a
rename variable
iaacornus Jan 4, 2023
27d5cb0
return a temporary arr again for extension of orignal arr
iaacornus Jan 4, 2023
5d00ce3
use more stupid but consistent variable names
iaacornus Jan 4, 2023
a8f1e68
update imports
iaacornus Jan 4, 2023
619ebf6
fix mypy errors
iaacornus Jan 4, 2023
d903d9e
rename modules
iaacornus Jan 4, 2023
636ff49
include sections
iaacornus Jan 6, 2023
19f5fe9
turn into class to organize the methods
iaacornus Jan 6, 2023
06a36da
update documentation
iaacornus Jan 6, 2023
b4f92a6
remove unused parameters and variables
iaacornus Jan 6, 2023
e888081
rename variables to avoid confusion
iaacornus Jan 6, 2023
3653345
include aid and sdesc value for the keys
iaacornus Jan 6, 2023
968d693
use the same format to include more information about the recommended…
iaacornus Jan 6, 2023
8dd5871
merge the flatpak and rpm program for install list
iaacornus Jan 6, 2023
4bda928
merge the json of flatpak and rpm uinstall list
iaacornus Jan 6, 2023
f8a4309
remove deprecated config files in the arr
iaacornus Jan 6, 2023
878ac10
initial commit on revision of uninstall class
iaacornus Jan 6, 2023
2da4a8b
update address of configs for fetch
iaacornus Jan 6, 2023
b72f332
update configvalues alias to the new config
iaacornus Jan 6, 2023
191b18f
put back console
iaacornus Jan 6, 2023
84389c4
combine install.py & uninstall.py
iaacornus Jan 8, 2023
29699b1
include fp_ and rpm_ prefixes to separate flatpaks from rpms
iaacornus Jan 8, 2023
44d8729
include warning
iaacornus Jan 8, 2023
db67bc1
for disabling of system services/autostart programs
iaacornus Jan 8, 2023
71fcca0
turn into a class only for system optimization
iaacornus Jan 8, 2023
85fe78b
include constructor
iaacornus Jan 8, 2023
d342931
initial commit on disabling of ssd workqueue
iaacornus Jan 8, 2023
7a78c5a
change shell and finalization initial commit
iaacornus Jan 9, 2023
eead94e
include tainted rpmfusion for free and nonfree #6
iaacornus Jan 9, 2023
a1a5923
update desc of rpmfusion free and nonfree from official faq of rpmfusion
iaacornus Jan 9, 2023
5047d89
fill the desc of fedora oci flatpak repo
iaacornus Jan 9, 2023
1c2eef1
initial commit for #15
iaacornus Jan 9, 2023
cc2f6c4
create a method for de based optimizations
iaacornus Jan 9, 2023
a871f89
include conf_link as parameter for user defined values
iaacornus Jan 12, 2023
9ba0727
default links to app_for_install & app_for_uninstall
iaacornus Jan 12, 2023
3b17f9f
contributing.md for first time contributors
iaacornus Jan 23, 2023
94eb8e2
code of conduct for new contributors
iaacornus Jan 23, 2023
6a22572
guidelines for how to start working in project
iaacornus Jan 23, 2023
f38e2b5
include contributing section in readme and update program description
iaacornus Jan 23, 2023
7b48b33
update information in contributing.md
iaacornus Jan 23, 2023
1f0143a
include notes
iaacornus Jan 23, 2023
bb79041
include more notes
iaacornus Jan 23, 2023
1f7b3ea
initial commit in documentation
iaacornus Jan 23, 2023
48112bd
documentation about structure of the project
iaacornus Jan 23, 2023
7821dc3
for system optimization
iaacornus Jan 23, 2023
36a01bd
for program installation and removal
iaacornus Jan 23, 2023
8201312
for system wide changes
iaacornus Jan 23, 2023
412adad
for drivers and codecs
iaacornus Jan 23, 2023
d46e839
restructure utils.core
iaacornus Jan 23, 2023
91185d4
change t_rpm_prog from list[str] to dict[str, list[str]]
iaacornus Jan 24, 2023
6063bcb
include source parameter that specify the repository of the program
iaacornus Jan 24, 2023
a531f42
merge the two dictionary and include source parameter
iaacornus Jan 24, 2023
4d7032c
update type alias of progdata
iaacornus Jan 24, 2023
c798647
broadly specify source for all rpm apps as rpm for testing purposes
iaacornus Jan 24, 2023
7766f81
remove other parameters specific to flatpak and rpm
iaacornus Jan 24, 2023
6a32f07
remove use of zip() in dictionary comprehension in sorting of program…
iaacornus Jan 24, 2023
33620fe
test block for src.utils.core.programs.add_remove
iaacornus Jan 24, 2023
ef3e907
move scripts to scripts/
iaacornus Jan 24, 2023
abc7fa8
prefix r_ to rpm applications
iaacornus Jan 24, 2023
e5e4739
suffix _ in parameters to avoid shadowing arguments of function
iaacornus Jan 24, 2023
32896dd
swap the value of title_ & msg_ if msg_ is none
iaacornus Jan 24, 2023
6e32e16
remove progtype parameter and update arguments of section()
iaacornus Jan 24, 2023
c566ee4
type hint the 4 variables in dict comprehension
iaacornus Jan 24, 2023
436f2fc
update aid of rpm programs
iaacornus Jan 24, 2023
36495b6
replace source of flatpak applications to flathub
iaacornus Jan 24, 2023
9548655
put back progtype and update section msg
iaacornus Jan 24, 2023
6f47462
sort rpm applications based on the repository
iaacornus Jan 24, 2023
5519a3e
update test block for src.utils.core.programs.app_remove
iaacornus Jan 24, 2023
5754cdd
update type hints
iaacornus Jan 24, 2023
65cf2e2
remove unused type: ignore
iaacornus Jan 24, 2023
4d1d73a
rename to general_opt to be more specific
iaacornus Jan 28, 2023
7551dea
for optimizations that depends on each variant of atomic workstation
iaacornus Jan 28, 2023
7758475
lowercare the user input in mode 3
iaacornus Jan 28, 2023
cc0c1bb
_fetch_variant method for variant based optimizations
iaacornus Jan 28, 2023
fb5e286
merge two conditions and chain call the methods passed
iaacornus Jan 28, 2023
10c428c
include .replace() method to remove accidental entry of new line
iaacornus Jan 28, 2023
f6fd64f
initial commit on variants
iaacornus Jan 28, 2023
fd04021
take variant as parameter
iaacornus Jan 28, 2023
a6c4e5c
use dictionary instead of repetitive pattern matching over the methods
iaacornus Jan 28, 2023
a2c6d7d
system optimization for silverblue variant
iaacornus Jan 28, 2023
6bf9899
remove de_based_opt... method
iaacornus Jan 28, 2023
4872516
include psutil==5.9.4
iaacornus Jan 28, 2023
5af2d66
initial commit on determining whether a partition is encrypted
iaacornus Jan 29, 2023
654ed22
initial commit on determining whether a partition is encrypted
iaacornus Jan 29, 2023
6c51f58
initial commit on laptop improvements (#17)
iaacornus Jan 29, 2023
ae7239b
include support for pipe in commands
iaacornus Jan 29, 2023
a9d1517
include pipe_ and init_cmd to docstring
iaacornus Jan 29, 2023
349701f
update docstring
iaacornus Jan 29, 2023
66afe0a
rename parameter command to cmd
iaacornus Jan 29, 2023
355c3e7
remove extra and unnecessary else statement
iaacornus Jan 29, 2023
c54fe5a
fix lines exceeding 79 lines, update type hint and simplify syntax
iaacornus Jan 29, 2023
41e7d8e
implement exec.exec_cmd pipe feature and replace manual piping
iaacornus Jan 29, 2023
7fc8732
initial commit on kbd backlight #17
iaacornus Jan 29, 2023
1c8d333
install method
iaacornus Jan 30, 2023
59639fe
update
iaacornus Jan 30, 2023
644ce3b
check if mypy exists or not before executing the command
iaacornus Jan 30, 2023
c9189fc
check if the system is installed in ssd or not
iaacornus Feb 1, 2023
9a45f2a
include blkinfo==0.2.0
iaacornus Feb 1, 2023
0a2a983
fix ambigous name add_remove by renaming to setup.py
iaacornus Feb 7, 2023
fff8875
rename src.utils.core.programs to src.utils.core.program
iaacornus Feb 7, 2023
589d98c
fix the erroneous checking of whether mypy exists or not
iaacornus Feb 7, 2023
77dfefd
fix type hint errors as well as other errors including
iaacornus Feb 7, 2023
8fc376c
include stubs for psutil, types-psutil==5.9.5.6
iaacornus Feb 7, 2023
5701a0b
Merge branch 'main' into devel
iaacornus Mar 4, 2023
1ce88ad
moved to asses/tests
iaacornus Mar 4, 2023
4fc514f
create archives folder for organization
iaacornus Mar 4, 2023
5773328
shorten lines to 72 char
iaacornus Mar 4, 2023
ae10533
shorten lines to 72 char
iaacornus Mar 4, 2023
240e7c5
include id for identification of repo
iaacornus Mar 4, 2023
4cac247
update conditions
iaacornus Mar 4, 2023
c4b8a36
update sequence of items in dict
iaacornus Mar 4, 2023
391338f
include some settings for v0.1
iaacornus Mar 4, 2023
f950838
include some settings for v0.1, initial commit for #59
iaacornus Mar 4, 2023
72628a2
update names of params
iaacornus Mar 4, 2023
b15105f
update module names corresponding to names of params in conf
iaacornus Mar 4, 2023
9a6e2f0
use a subject-action format in name of params
iaacornus Mar 4, 2023
9d72dff
added more configs, extended some names, reordered
boredsquirrel Mar 4, 2023
33641d6
added more configs, extended some names, reordered
boredsquirrel Mar 4, 2023
9a26409
minor changes and descriptions
boredsquirrel Mar 4, 2023
4b759a5
added apps I layer
boredsquirrel Mar 4, 2023
657e0d9
Merge pull request #68 from trytomakeyouprivate/patch-9
iaacornus Mar 5, 2023
ec5e633
remove extra quotation
iaacornus Mar 5, 2023
920917c
Merge pull request #69 from trytomakeyouprivate/patch-10
iaacornus Mar 5, 2023
3f18e1c
remove kde and improve syntax in align to the previous commit
iaacornus Mar 5, 2023
943d14a
Merge pull request #67 from trytomakeyouprivate/patch-8
iaacornus Mar 5, 2023
68bb2a8
Merge branch 'devel' into patch-6
iaacornus Mar 5, 2023
df0eb7a
Merge pull request #66 from trytomakeyouprivate/patch-6
iaacornus Mar 5, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions .github/workflows/pytest.yaml
Original file line number Diff line number Diff line change
@@ -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: .
Empty file modified .gitignore
100644 → 100755
Empty file.
19 changes: 11 additions & 8 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
36 changes: 19 additions & 17 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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] = [
Expand All @@ -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).
3 changes: 3 additions & 0 deletions DEV_REQUIREMENTS
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
mypy==0.991
types-requests==2.28.11.7
types-psutil==5.9.5.6
41 changes: 22 additions & 19 deletions HACKING.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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
Expand All @@ -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:
Expand All @@ -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
Expand All @@ -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.
27 changes: 27 additions & 0 deletions INSTALLATION.md
Original file line number Diff line number Diff line change
@@ -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
```
Empty file modified LICENSE
100644 → 100755
Empty file.
14 changes: 13 additions & 1 deletion README.md
100644 → 100755
Original file line number Diff line number Diff line change
@@ -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.
4 changes: 4 additions & 0 deletions REQUIREMENTS
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
rich==12.6.0
requests==2.28.1
psutil==5.9.4
blkinfo==0.2.0
Loading