commit 2fcf9bfddabd285dc92f1c5566b12bd5d30473f9 Author: g* Date: Thu Jun 12 09:39:35 2025 +0200 Reset author diff --git a/.env b/.env new file mode 100644 index 0000000..eef0667 --- /dev/null +++ b/.env @@ -0,0 +1,33 @@ +venv_dir=".venv" +currentvenv="" +get_project_root() { + local current_dir="$PWD" + while [[ "$current_dir" != "" && ! -d "$current_dir/$venv_dir" ]]; do + current_dir=${current_dir%/*} + done + echo "$current_dir" +} + +root_dir=$(get_project_root) + +if [[ -z "$root_dir" || ! -d "$root_dir/$venv_dir" ]]; then + echo "Unable to find the virtual environment folder." + return +fi + +if [[ $VIRTUAL_ENV != "" ]]; then + currentvenv="${VIRTUAL_ENV##*/}" +fi + +if [[ "$currentvenv" != "$venv_dir" ]]; then + python_version=$(python3 --version 2>&1) + echo "Switching to environment: $venv_dir | $python_version" + source "$root_dir/$venv_dir/bin/activate" +fi + +pip freeze > requirements.txt +sed -i "" -e "s/==/>=/" requirements.txt +pip install --upgrade pip +pip -q install -r requirements.txt +echo "Updated pip packages." + diff --git a/.env.leave b/.env.leave new file mode 100644 index 0000000..d1898d7 --- /dev/null +++ b/.env.leave @@ -0,0 +1 @@ +deactivate diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..a8fa35b --- /dev/null +++ b/.gitattributes @@ -0,0 +1,5 @@ +**.pdf filter=lfs diff=lfs merge=lfs -text +**.gif filter=lfs diff=lfs merge=lfs -text +**.jpeg filter=lfs diff=lfs merge=lfs -text +**.jpg filter=lfs diff=lfs merge=lfs -text +**.png filter=lfs diff=lfs merge=lfs -text diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml new file mode 100644 index 0000000..dd6cb46 --- /dev/null +++ b/.github/workflows/lint.yml @@ -0,0 +1,15 @@ +name: lint +on: + push: + branches: + - main +jobs: + vale: + name: runner / vale + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: errata-ai/vale-action@reviewdog + with: + fail_on_error: true + files: docs/ diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..f3680e2 --- /dev/null +++ b/.gitignore @@ -0,0 +1,133 @@ +.DS_Store + +# Special excludes +archive/ +*.bak + +# 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 +.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 +.venv +.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/ + +# PyPI configuration file +.pypirc diff --git a/.vale.ini b/.vale.ini new file mode 100644 index 0000000..cdcf46e --- /dev/null +++ b/.vale.ini @@ -0,0 +1,7 @@ +StylesPath = styles +MinAlertLevel = suggestion +Packages = Google, write-good + +[*.md] +BasedOnStyles = Vale, Google, write-good, extend-spell +Vale.Spelling = NO diff --git a/docs/code-data.md b/docs/code-data.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/includes/defintions.md b/docs/includes/defintions.md new file mode 100644 index 0000000..2dc2c76 --- /dev/null +++ b/docs/includes/defintions.md @@ -0,0 +1,2 @@ + +*[data]: Data defined as raw input, which when processed becomes information. Wisdom and knowledge are higher levels of information alloyed with experience. *[ADB]: The Android Debug Bridge lets you communicate with your Android or wearOS device via the terminal (or console). You can install apps, push orpull files, and change settings using commands. diff --git a/docs/includes/snippets.yml b/docs/includes/snippets.yml new file mode 100644 index 0000000..e69de29 diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..3b3827d --- /dev/null +++ b/docs/index.md @@ -0,0 +1,37 @@ +--- +title: Gugulethu Hlekwayo +description: "i'm a writer..." +hide: + - toc + - navigation + - footer +--- + + + +
+
+

hi, i'm g* and i write

+

...

+
+
+
+
+ +
+
+ +
+
+ +
+
+
+ +> + +
+
+
+ + diff --git a/docs/index2.md b/docs/index2.md new file mode 100644 index 0000000..5f33111 --- /dev/null +++ b/docs/index2.md @@ -0,0 +1,196 @@ +--- +title: Gugulethu Hlekwayo +description: "This is not the website you're looking for." +hide: + - toc + - navigation + - footer +--- + + + + + +
+
+ + +
+ + diff --git a/docs/index3.md b/docs/index3.md new file mode 100644 index 0000000..48314f0 --- /dev/null +++ b/docs/index3.md @@ -0,0 +1,75 @@ +--- +title: Gugulethu Hlekwayo +description: "This is not the website you're looking for." +hide: + - toc + - navigation + - footer +--- + + + + + + + + +
+
+
+
a thousand words at a time
+
+
+
+
+
words for humans
+
+
+
+
+
> console.log("words")
+
+
+
diff --git a/docs/overrides/main.html b/docs/overrides/main.html new file mode 100644 index 0000000..939d223 --- /dev/null +++ b/docs/overrides/main.html @@ -0,0 +1,38 @@ +{% extends "base.html" %} + +{% block scripts %} + +{{ super() }} + + + + + +{% endblock %} diff --git a/docs/qself/financial/assets/index.md b/docs/qself/financial/assets/index.md new file mode 100644 index 0000000..acc6cb6 --- /dev/null +++ b/docs/qself/financial/assets/index.md @@ -0,0 +1,6 @@ +--- +title: "Assets and Logistics" +description: "An overview of the asset management and logistics features of the project." +weight: 30 +headless: true +--- diff --git a/docs/qself/financial/index.md b/docs/qself/financial/index.md new file mode 100644 index 0000000..399e8c6 --- /dev/null +++ b/docs/qself/financial/index.md @@ -0,0 +1,26 @@ +--- +title: "Financial" +description: "An overview of the financial aspect of the project." +tags: + - HTML + - JavaScript + - CSS + - Logic +--- + +The financial aspect of the qSelf project tracks and processes expenses, investments, income, assets, and logistics: + +* **Expenses:** The fundamental unit tracked is transactions. For more information see the [Transactions](transactions/index.md) page. +* **Investment:** The investment portfolio is tracked using transaction data, with extra information, and is stored in the investment table. For more information see the [Investment](investment/index.md) page. +* **Assets and Logistics:** Records asset purchases and monitors their value, state, and location with a logistics component. For more information see the [Assets](assets/index.md) page. + +## Reconciliation +To keep financial information accurate, the reconciliation flows run on a set schedule to check that the liquid money available, investment portfolio value, asset value, and other balances correspond with the reality. This is the primary function of the [`4 Finances`](https://github.com/gugulet-hu/qself-process/tree/main/automate/4%20Finances) flow, which serves all the other financial subflows. + +_TBC_ + + + + + + diff --git a/docs/qself/financial/investment/index.md b/docs/qself/financial/investment/index.md new file mode 100644 index 0000000..2bfc38c --- /dev/null +++ b/docs/qself/financial/investment/index.md @@ -0,0 +1,6 @@ +--- +title: "Investment" +description: "An overview of the investment management feature of the project." +weight: 20 +headless: true +--- diff --git a/docs/qself/financial/transactions/index.md b/docs/qself/financial/transactions/index.md new file mode 100644 index 0000000..7b25f8b --- /dev/null +++ b/docs/qself/financial/transactions/index.md @@ -0,0 +1,14 @@ +--- +title: "Transactions" +description: "An overview of the root financial feature of transaction tracking." +--- + + +All financial tracking starts as a transaction, which has the following structure. + +| Parameter | Type | Description | Required | + + +The logic for collecting transactions is handled by the `4a Transactions` flow in Automate, which presents an input form, returns the data via query parameters, and enriches the data with exchange rate information, where necessary, and unit cost calculations. + +_TBC_ diff --git a/docs/qself/getting-started/index.md b/docs/qself/getting-started/index.md new file mode 100644 index 0000000..ee21cf6 --- /dev/null +++ b/docs/qself/getting-started/index.md @@ -0,0 +1,62 @@ +--- +title: "Getting started" +description: "Getting all the prerequisite tools and software needed to get the project going." +--- + +The qSelf project is made up of a number of inter-connected components: + +* **Logical components:** These are responsible for the logical progression of flows, moving data from screens and sensors to the database and further on to displays. +* **Sensory components:** These components collect external data from various sensors (mostly from the smartwatch). +* **Input and Display components:** These are responsible for receiving manually inputted data that supplements sensory data. The display components display the processed data on dashboards and reports. +* **Analytical components:** These components take the received data and parse it into useful information. +* **Storage and Sync components:** These components take data and store it in the SQLCipher database or in temp files for quick retrieval. + +Components are immutable, but the tools that make them work are replaceable and interchangeable. + +**Diagram: Topology of the qSelf system** + +![The topology of the qSelf system from a wide view.](qs-topology-3333x3333.webp "This is a Title"){width=750} + +## Install + +### 1. Install all applications and tools +Install all applications in the toolset table. This includes CLI tools that are listed in the Termux row, and plugins for Automate. + +### 2. Clone the project repo +Clone the project repo to the root of your user space on your mobile device using Termux and the following commands: + +``` +cd /storage/emulated/0/ +git clone git@github.com:gugulet-hu/qself-process.git +``` + +### 3. Import flows into Automate and displays into Kustom +Import the `latest.flo` files in each of the directories in the **qself-process/Automate/** folder. Inside Automate, the dot menu in the top-left corner includes the option to **Import**. Import the files in the **qself-process/Kustom/wallpapers/** folder into KLWP and import the files in the **qself-process/Kustom/watchfaces/** folder into KWCH. + +### 4. Configure the root settings +Configure the root settings in **qself-process/Automate/.demo-config.json** file and rename the file to **.config.json**. + +### 5. Start the [`1 Context`](https://github.com/gugulet-hu/qself-process/tree/main/automate/1%20Context) flow in Automate + +## Toolset + +| Component | Tool | Device | Description | Install | Learn | +| --- | --- | :---: | --- | --- | --- | +| Logical | Python | [:material-laptop:](../reference/devices/index.md#laptop) | Python is a general purpose programming language used for data analysis and various scripts. | [Python](https://www.python.org/) | [TreeHouse](https://teamtreehouse.com/tracks/beginning-python) | +| | Automate | [:material-cellphone:](../reference/devices/index.md#mobile) | Automate is a graphical code tool to create and manage logic on the mobile device. The project also requires these Tasker plugins: [AutoWear, AutoInput](https://joaoapps.com/), [Termux:Tasker](https://github.com/termux/termux-tasker), [Sleep as Android](https://docs.sleep.urbandroid.org/services/tasker_automate.html), and [Kustom](https://docs.kustom.rocks/) (the last two apps come with their respective Automate plugins). | [Google Play](https://play.google.com/store/apps/details?id=com.llamalab.automate) | [LlamaLab](https://llamalab.com/automate/doc/index.html) | +| Sensory | wearOS device | [:material-watch:](../reference/devices/index.md#watch) | Any wearOS compatible smartwatch. The TicWatch Pro 5 is recommended for its battery life and general ease of use. It can also be rooted quite easily, unlike Samsung devices. | [TicWatch](https://www.mobvoi.com/us/pages/ticwatchpro5) | | +| | Android smartphone | [:material-cellphone:](../reference/devices/index.md#mobile) | The smartphone is a fallback option for certain types of sensory input, such as Steps. The Pixel series is a lean option without the junkware from other Android device manufacturers. You can overlay it with [Graphene OS](https://grapheneos.org/) to somewhat protect yourself from Google tracking and annoyances. | [Pixel](https://store.google.com/category/phones) | | +| | Sleep as Android | [:material-cellphone:](../reference/devices/index.md#mobile) [:material-watch:](../reference/devices/index.md#watch) | This app is the most reliable sleep tracker for Android. Make sure to turn off the features that send your data to the developer. It is deeply integrated into the way the sleep track flow works. | [Google Play](https://play.google.com/store/apps/details?id=com.urbandroid.sleep) | [Docs](https://www.docs.sleep.urbandroid.org/services/automation.html) | +| Input and Display | HTML | [:material-laptop:](../reference/devices/index.md#laptop) | HTML is required foundational knowledge to create web screens to accept manual inputs. | | | +| | CSS | [:material-laptop:](../reference/devices/index.md#laptop) | CSS is required foundational knowledge to create web screens to accept manual inputs. Better yet, Sass to manage the complexity of some of the input screens. | | | +| | JavaScript | [:material-laptop:](../reference/devices/index.md#laptop) | JavaScript is required foundational knowledge to create web screens to accept manual inputs. Some JS is also required for using advanced Automate techniques. | | | +| | KLWP | [:material-cellphone:](../reference/devices/index.md#mobile) | Kustom Live Wallpaper allows you to create interactive home screens and is a pretty powerful logical engine of its own. Most of the data is piped to the home screen dashboard for easy access. | [Google Play](https://play.google.com/store/apps/details?id=org.kustom.wallpaper&hl=en&gl=US) | [Kustom](https://docs.kustom.rocks/) | +| | KWCH | [:material-cellphone:](../reference/devices/index.md#mobile) [:material-watch:](../reference/devices/index.md#watch) | Kustom Watch Face allows you to create watch faces using the Kustom interface. Like KLWP, it is also capable of doing logical operations. | [Google Play](https://play.google.com/store/apps/details?id=org.kustom.watchface&hl=en&gl=US) | [Kustom](https://docs.kustom.rocks/) | +| Analytical | TBA | | | | | +| Storage and Sync | SQLCipher | [:material-cellphone:](../reference/devices/index.md#mobile) [:material-laptop:](../reference/devices/index.md#laptop) | SQLCipher is the secure version of SQLite. The commands and queries are largely the same, except for the parts to access the database. | [GitHub](https://github.com/sqlcipher/sqlcipher) | [Zetetic](https://www.zetetic.net/sqlcipher/) | +| | TablePlus | [:material-laptop:](../reference/devices/index.md#laptop) | GUI tool for relational databases. In this project used to manually edit the database when things go wrong. Also useful to create queries. | [TablePlus](https://tableplus.com/) | [Docs](https://docs.tableplus.com/) | +| | Termux | [:material-cellphone:](../reference/devices/index.md#mobile) | Termux is a terminal for Android that allows you to send commands for many popular application. For this project it is used for git commands and a couple of advanced techniques. The following packages are installed using the `pkg install ` command: curl, gh, git, openssh, python, sqlcipher, termux-api, and termux-tools. | [GitHub](https://github.com/termux/termux-app/releases) | [Termux](https://termux.dev/en/) | +| | iTerm2 | [:material-laptop:](../reference/devices/index.md#laptop) | iTerm is my preferred console for macOS. See the description for Termux for which CLI tools to install using the command `brew install `. [Homebrew](https://brew.sh/) will also need to be installed. | [iTerm](https://iterm2.com/) | [Docs](https://iterm2.com/documentation.html) | +| | Syncthing | [:material-cellphone:](../reference/devices/index.md#mobile) [:material-laptop:](../reference/devices/index.md#laptop) | Syncthing syncs folders and files across devices. Used to keep the project files updated between the laptop and the smartphone. | [Syncthing](https://syncthing.net/downloads/) | [Docs](https://docs.syncthing.net/) | + + diff --git a/docs/qself/health/exercise/index.md b/docs/qself/health/exercise/index.md new file mode 100644 index 0000000..8ae0569 --- /dev/null +++ b/docs/qself/health/exercise/index.md @@ -0,0 +1 @@ +# Test diff --git a/docs/qself/health/index.md b/docs/qself/health/index.md new file mode 100644 index 0000000..ca03031 --- /dev/null +++ b/docs/qself/health/index.md @@ -0,0 +1,3 @@ +--- +headless: true +--- diff --git a/docs/qself/health/metrics/index.md b/docs/qself/health/metrics/index.md new file mode 100644 index 0000000..8ae0569 --- /dev/null +++ b/docs/qself/health/metrics/index.md @@ -0,0 +1 @@ +# Test diff --git a/docs/qself/health/sleep/index.md b/docs/qself/health/sleep/index.md new file mode 100644 index 0000000..8ae0569 --- /dev/null +++ b/docs/qself/health/sleep/index.md @@ -0,0 +1 @@ +# Test diff --git a/docs/qself/mental/emotional/index.md b/docs/qself/mental/emotional/index.md new file mode 100644 index 0000000..8ae0569 --- /dev/null +++ b/docs/qself/mental/emotional/index.md @@ -0,0 +1 @@ +# Test diff --git a/docs/qself/mental/index.md b/docs/qself/mental/index.md new file mode 100644 index 0000000..ca03031 --- /dev/null +++ b/docs/qself/mental/index.md @@ -0,0 +1,3 @@ +--- +headless: true +--- diff --git a/docs/qself/mental/media/index.md b/docs/qself/mental/media/index.md new file mode 100644 index 0000000..8ae0569 --- /dev/null +++ b/docs/qself/mental/media/index.md @@ -0,0 +1 @@ +# Test diff --git a/docs/qself/mental/productivity/index.md b/docs/qself/mental/productivity/index.md new file mode 100644 index 0000000..8ae0569 --- /dev/null +++ b/docs/qself/mental/productivity/index.md @@ -0,0 +1 @@ +# Test diff --git a/docs/qself/qself.md b/docs/qself/qself.md new file mode 100644 index 0000000..03ce013 --- /dev/null +++ b/docs/qself/qself.md @@ -0,0 +1,61 @@ +--- +title: "Overview" +description: "An overview of my quantified self project, which tracks over 50 personal metrics." +tags: + - HTML + - JavaScript + - CSS + - Python + - Shell + - Logic + - Manual + - Database + - Collect + - Validate + - Display + - Sync + - Analyse + - Predict + - Watch + - Mobile + - Laptop +--- + +According to legend, the first maxim of the Oracle of Delphi - said to spring from Apollo himself - is to know yourself. Or in Greek: _nosce te ipsum, temet nosce_. Repeated twice for emphasis and for nuance. Know yourself, to your own self be known. To know and have knowledge of yourself and then to process that knowledge. To know and to accept. + +The purpose of what has been a decades-long interest for me is exactly that, but a little more. What value do the days [23 September 2004](https://en.wikipedia.org/wiki/Portal:Current_events/September_2004#2004_September_23), or [8 July 1995](https://en.wikipedia.org/wiki/July_1995), or [17 February 2017](https://en.wikipedia.org/wiki/Portal:Current_events/February_2017#2017_February_17) have if they are remembered and known nowhere. Who were you on these days? We edit our lives like film editors, cutting out the boring bits - but are these not the foundation of who we are. The accumulation of a person are the days without monumental events - where a series of small and large decisions define you, who you were, and who you will be. And in that way this project is also a data diary of a person. In an age where social media networks, search engines, and a hungry horde of algorithms know us better than we know ourselves - this project is my redoubt. I should be the expert of myself, and I should endeavour to be better for that challenge. + +This documentation set covers the mechanism of collecting, analysing, and displaying information about myself to myself. As such, the primary reader is me - but if you find something of use, please feel free to use it. There will be typos, broken processes, and periods of inactivity - because life doesn't stop for measurements. + +![The history of the qSelf project](qs-project-history-333x1189.webp) + +## Principles + +**Own all the data exclusively**
+Avoid storing any data on external services, even temporarily. This especially applies to health data. + +**Delete nothing**
+Preserve all collected and validated data, as it may have an unimagined use in the future. + +**Automate as much as possible**
+Automate as much of the collection of data as possible to avoid influencing the results. The process should not impinge on the output. + +## Data collected + +This list may grow and contract over time, as new data sources are added and others are hidden. + +**Financial:** Daily transactions (amount, time, date, category, subcategory, accounts, currency, location, brand, item, liquid balance), Investments (amount, asset type, region, growth/loss), Assets (details, cost, serial, logistics) + +**Health:** Exercise (reps, sets, exercises, bpm, location, weather), Metrics (heart rate, resting heart rate, average heart rate, weight, height, haemotocrit, haemoglobin, eosinophils, basophils, lymphocytes, monocytes, neutrophils, platelet count, red cell count, white cell count, mean cell haemoglobin, mean cell volume, mean cell volume, mean corpuscular haemoglobin, red blood width, esr, systolic, diastolic, waist circumference, body fat, chest circumference, thigh circumference, body fat mass, skeletal muscle mass, visceral fat, body water, total cholesterol, hdl cholesterol, ldl cholesterol, triglyceride, pGlucose fasting, anion gap, bicarbonate, chloride, potassium, sodium, urea, creatinine, b12, ferritin, tsh, freet4, thyroid peroxidase, eye axis, eye cylinder, eye sphere, vo2max, avgspo2, sperm motility, sperm count), Sleep (sleep phases, duration, location, weather, air pressure, ambient light, sleep time, awake time) + +**Mental:** Media (books, movies, tv, theatre, exhibitions), Productivity (focus sessions), Activities (reading, writing, media, art, games, meditation, technical, media, piano, design) + +**Diagram: Data cycle** + +![The data cycle of the qSelf project: collection, analysis, prediction, and display](qs-data-cycle-3333x3333.webp){width=750} + +## Roadmap + +Work on this project is planned and managed on this [task board](https://github.com/users/gugulet-hu/projects/1/views/5). + + diff --git a/docs/qself/reference/devices/index.md b/docs/qself/reference/devices/index.md new file mode 100644 index 0000000..dad6214 --- /dev/null +++ b/docs/qself/reference/devices/index.md @@ -0,0 +1,121 @@ +--- +title: "Devices" +description: "Some tips and tricks for working with the devices that enable the project." +tags: + - Watch + - Mobile + - Laptop +--- + +## :material-cellphone: Mobile + +The mobile device used in the qSelf project needs to run the Android operating system; preferably the latest version. Most manufacturers add cruft to their devices, so the Pixel series is recommended for its focus on the pure Android experience. Furthermore, the Graphene-flavoured version of Android gives you more control of your privacy and device use compared to standard Android. The device should be unrooted, but with [Developer options](https://www.howtogeek.com/129728/how-to-enable-developer-options-menu-and-enable-and-usb-debugging-on-android/) enabled. This lets you use the Android Debug Bridge (ADB). + +To install Graphene, see their [user guide](https://grapheneos.org/install/) for instructions. + +## :material-watch: Watch + +Similarly to the mobile device, the smartwatch needs to run wearOS 3+. The TicWatch series of smartwatches has good battery life and a reasonable number of sensors. You may need to disable or remove additional software added by the manufacturer to get better battery life and less interference. The device should be unrooted, but with [Developer options](https://developer.android.com/training/wearables/get-started/debugging) enabled. This lets wirelessly connect using ADB. + +The commands that follow can help you debloat your device and make it run smoother. + +### Connect to device + +Once you have enabled ADB via wi-fi and you have the device's address you can connect to the device run the following command from your terminal or console. + +=== "Code" + + adb connect + adb connect : + + +=== "Example" + adb connect 192.168.123.132 + adb connect 192.168.123.132:12345 + +| Part | Description | Required | +| --- | --- | --- | +| `adb` | The Android Debugging Bridge CLI tool. To install it on Termux, use: `pkg install android-tools`. To install it on macOS, using homebrew: `brew install android-tools`. | Yes | +| `connect` | The command to connect over wi-fi to the device. | Yes | +| `` | You can find the IP address on your device when you turn on ADB over wi-fi. It is usually located in **Settings** > **Developer options** > **Wireless debugging**. The command to connect without the port number may be necessary to prompt the permissions dialog, which confirms that you want to connect to this device on the first attempt. | Yes | +| `` | The port number can usually be found in **Settings** > **Developer options** > **Wireless debugging**. The port number is required when there is more than one device connected via ADB. | No | + +### Grant permissions to apps + +To allow autoWear, for example, to change secure settings (such as toggling Theatre Mode) use the following command. + +=== "Code" + adb -s ":" shell pm grant + +=== "Example" + adb -s "192.168.123.132:12345" shell pm grant com.joaomgcd.autowear android.permission.WRITE_SECURE_SETTINGS + +| Part | Description | Required | +| --- | --- | --- | +| `adb` | The Android Debugging Bridge CLI tool. To install it on Termux, use: `pkg install android-tools`. To install it on macOS, using homebrew: `brew install android-tools`. | Yes | +| `-s` | This flag selects a particular device when there is more than one device connected via ADB. | No | +| `` | This IP address can be found in **Settings** > **Developer options** > **Wireless debugging**. The command to connect without the port number may be necessary to prompt the permissions dialog, which confirms that you want to connect to this device on the first connection. | Yes | +| `` | The port number is in **Settings** > **Developer options** > **Wireless debugging**. The port number is required when there is more than one device connected via ADB. | No | +| `shell` | The shell for interacting with ADB. | Yes | +| `pm` | Short for package manager, which manages apps on an Android or wearOS device. | Yes | +| `grant ` | Grant this package these permissions on the device. | Yes | + +### List system apps + +To list all the manufacturer applications installed. + +=== "Code" + adb -s ":" shell pm list packages -s -e + +=== "Example" + adb -s "192.168.123.132:12345" shell pm list packages -s -e mobvoi + +| Part | Description | Required | +| --- | --- | --- | +| `adb` | The Android Debugging Bridge CLI tool. To install it on Termux, use: `pkg install android-tools`. To install it on macOS, using homebrew: `brew install android-tools`. | Yes | +| `-s` | This flag selects a particular device when there is more than one device connected via ADB. | No | +| `` | This IP address can be found in **Settings** > **Developer options** > **Wireless debugging**. The command to connect without the port number may be necessary to prompt the permissions dialog, which confirms that you want to connect to this device on the first attempt. | Yes | +| `` | The port number is in **Settings** > **Developer options** > **Wireless debugging**. The port number is required when there is more than one device connected via ADB. | No | +| `shell` | The shell for interacting with ADB. | Yes | +| `pm` | Short for package manager, which manages apps on an Android or wearOS device. | Yes | +| `list packages` | List all the packages that meet the conditions that follow. | Yes | +| `-s` | A flag to filter for system apps. | No | +| `-e` | A flag to filter for enabled apps. To filter for disabled apps use `-d`. | No | + +### Disable system apps + +To disable a manufacturer's app on your device. + +=== "Code" + adb -s ":" shell pm disable-user --user 0 + +=== "Example" + adb -s "192.168.123.132:12345" shell pm disable-user --user 0 com.mobvoi.wear.mcuservice.aw + +| Part | Description | Required | +| --- | --- | --- | +| `adb` | The Android Debugging Bridge CLI tool. To install it on Termux, use: `pkg install android-tools`. To install it on macOS, using homebrew: `brew install android-tools`. | Yes | +| `-s` | This flag selects a particular device when there is more than one device connected via ADB. | No | +| `` | This IP address can be found in **Settings** > **Developer options** > **Wireless debugging**. The command to connect without the port number may be necessary to prompt the permissions dialog, which confirms that you want to connect to this device on the first attempt. | Yes | +| `` | The port number is in **Settings** > **Developer options** > **Wireless debugging**. The port number is required when there is more than one device connected via ADB. | No | +| `shell` | The shell for interacting with ADB. | Yes | +| `pm` | Short for package manager, which manages apps on an Android or wearOS device. | Yes | +| `disable-user --user 0` | Disable the following app on the device. | Yes | +| `` | The name of the package to disable. You can find the package names by [listing the packages](#list-system-apps). | Yes | + +## :material-laptop: Laptop + +Any laptop that can run Python is good enough for this project. + +!!! note "Using commands in Powershell" + + Please be aware that some terminal commands in Linux and macOS are different in Windows Powershell. There may be instances where you need to use ticks (`) to escape ceratin characters. + + + + + + + + + diff --git a/docs/qself/reference/index.md b/docs/qself/reference/index.md new file mode 100644 index 0000000..e778467 --- /dev/null +++ b/docs/qself/reference/index.md @@ -0,0 +1,4 @@ +--- +title: "Reference" +description: "Reference lookup for data models and device info" +--- diff --git a/docs/qself/src/qs-data-cycle-3333x3333.webp b/docs/qself/src/qs-data-cycle-3333x3333.webp new file mode 100644 index 0000000..73b7fd5 Binary files /dev/null and b/docs/qself/src/qs-data-cycle-3333x3333.webp differ diff --git a/docs/qself/src/qs-designs.key b/docs/qself/src/qs-designs.key new file mode 100755 index 0000000..d1fd3dc Binary files /dev/null and b/docs/qself/src/qs-designs.key differ diff --git a/docs/qself/src/qs-project-history-333x1189.webp b/docs/qself/src/qs-project-history-333x1189.webp new file mode 100644 index 0000000..2510259 Binary files /dev/null and b/docs/qself/src/qs-project-history-333x1189.webp differ diff --git a/docs/qself/src/qs-topology-3333x3333.webp b/docs/qself/src/qs-topology-3333x3333.webp new file mode 100644 index 0000000..fbd6c68 Binary files /dev/null and b/docs/qself/src/qs-topology-3333x3333.webp differ diff --git a/docs/qself/src/qself-favicon-200x200.ico b/docs/qself/src/qself-favicon-200x200.ico new file mode 100644 index 0000000..092445c Binary files /dev/null and b/docs/qself/src/qself-favicon-200x200.ico differ diff --git a/docs/qself/src/qself-logo-200x200.png b/docs/qself/src/qself-logo-200x200.png new file mode 100644 index 0000000..b2f590c --- /dev/null +++ b/docs/qself/src/qself-logo-200x200.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b0d669eb9e4a46862d81bc559cb58a959553fb603f02749fb4e3978c7bd5e3dd +size 26944 diff --git a/docs/qself/src/qself-logo-800x800.png b/docs/qself/src/qself-logo-800x800.png new file mode 100644 index 0000000..6f83db9 --- /dev/null +++ b/docs/qself/src/qself-logo-800x800.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c00c5951243eeed001d0fbe8a89f9314c6b9ee5110a46fca7e3cc0f40f1b88aa +size 28473 diff --git a/docs/qself/src/qself-project-3462x2310.jpg b/docs/qself/src/qself-project-3462x2310.jpg new file mode 100644 index 0000000..a777bd1 --- /dev/null +++ b/docs/qself/src/qself-project-3462x2310.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:206271e085358cec2c2182d9bb4902e19d77c9d00cbbf699cb79aaf6d3337571 +size 659933 diff --git a/docs/qself/src/step-1-running-local-setup-882x320.jpg b/docs/qself/src/step-1-running-local-setup-882x320.jpg new file mode 100644 index 0000000..f7ed609 --- /dev/null +++ b/docs/qself/src/step-1-running-local-setup-882x320.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:33df07a2042c7e9bcf38ba851c1783e8bdb08bb404369285646e4615c8382ff2 +size 73112 diff --git a/docs/qself/src/step-2-creating-new-workspace-1902x966.jpg b/docs/qself/src/step-2-creating-new-workspace-1902x966.jpg new file mode 100644 index 0000000..55c2e21 --- /dev/null +++ b/docs/qself/src/step-2-creating-new-workspace-1902x966.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8fba0428e55f993a2ebed25522aabfadf021e9e3cbc0dd65bb28f9fafd7b8dc5 +size 134024 diff --git a/docs/qself/src/step-3-configure-application-1902x966.jpg b/docs/qself/src/step-3-configure-application-1902x966.jpg new file mode 100644 index 0000000..2fe4aec --- /dev/null +++ b/docs/qself/src/step-3-configure-application-1902x966.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8c5a7b0fe5f9dc72adcf9b16d0c7a9f48cdab6936d339d5874f9769bd0e8c6d9 +size 103775 diff --git a/docs/qself/src/step-5-making-a-query-1902x966.jpg b/docs/qself/src/step-5-making-a-query-1902x966.jpg new file mode 100644 index 0000000..81b99d7 --- /dev/null +++ b/docs/qself/src/step-5-making-a-query-1902x966.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:809359b3b0fbc25730b0202b92c0129c6771e9392be1a65f3998519b835c2323 +size 138395 diff --git a/docs/qself/src/step-6-displaying-the-data-1902x966.jpg b/docs/qself/src/step-6-displaying-the-data-1902x966.jpg new file mode 100644 index 0000000..c9df0eb --- /dev/null +++ b/docs/qself/src/step-6-displaying-the-data-1902x966.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6ed56846380c4585b945a7212bda91f9cea471bc233b8886a6c44d2323db07e3 +size 154864 diff --git a/docs/qself/src/step-7-deploy-git-1902x966.jpg b/docs/qself/src/step-7-deploy-git-1902x966.jpg new file mode 100644 index 0000000..5bb424a --- /dev/null +++ b/docs/qself/src/step-7-deploy-git-1902x966.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fe1db66ef40db31991fb0bafb57718aa1fe4c7341ed2a998162006c0620355a0 +size 135476 diff --git a/docs/robots.txt b/docs/robots.txt new file mode 100644 index 0000000..65eefa9 --- /dev/null +++ b/docs/robots.txt @@ -0,0 +1,111 @@ +User-agent: Googlebot-Image +User-agent: msnbot-media +User-agent: GPTBot +User-agent: CCBot +User-agent: ChatGPT-User +User-agent: ia-archiver +User-agent: omgili +User-agent: omgili-bot +User-agent: Omgilibot +User-agent: img2dataset +User-agent: Twitterbot +User-agent: Google-Extended +User-agent: Applebot-Extended +User-agent: anthropic-ai +User-agent: Claude-Web +User-agent: FacebookBot +User-agent: Bytespider +User-agent: magpie-crawler +User-agent: AI2Bot +User-agent: Ai2Bot-Dolma +User-agent: Amazonbot +User-agent: anthropic-ai +User-agent: Applebot +User-agent: Applebot-Extended +User-agent: Bytespider +User-agent: Claude-Web +User-agent: ClaudeBot +User-agent: cohere-ai +User-agent: Diffbot +User-agent: DuckAssistBot +User-agent: FacebookBot +User-agent: FriendlyCrawler +User-agent: Google-Extended +User-agent: iaskspider/2.0 +User-agent: ICC-Crawler +User-agent: ImagesiftBot +User-agent: img2dataset +User-agent: ISSCyberRiskCrawler +User-agent: Kangaroo Bot +User-agent: Meta-ExternalAgent +User-agent: Meta-ExternalFetcher +User-agent: OAI-SearchBot +User-agent: omgili +User-agent: omgilibot +User-agent: PanguBot +User-agent: PerplexityBot +User-agent: PetalBot +User-agent: Scrapy +User-agent: Sidetrade indexer bot +User-agent: Timpibot +User-agent: VelenPublicWebCrawler +User-agent: Webzio-Extended +User-agent: YouBot + Disallow: / +User-Agent: * + Disallow: *.txt + Disallow: *.pdf + Disallow: *.doc + Disallow: *.docx + Disallow: *.odt + Disallow: *.rtf + Disallow: *.tex + Disallow: *.wks + Disallow: *.wpd + Disallow: *.wps + Disallow: *.html + Disallow: *.bmp + Disallow: *.gif + Disallow: *.ico + Disallow: *.jpeg + Disallow: *.jpg + Disallow: *.png + Disallow: *.svg + Disallow: *.tif + Disallow: *.tiff + Disallow: *.webp + Disallow: *.aac + Disallow: *.aiff + Disallow: *.amr + Disallow: *.flac + Disallow: *.m4a + Disallow: *.mp3 + Disallow: *.oga + Disallow: *.opus + Disallow: *.wav + Disallow: *.wma + Disallow: *.mp4 + Disallow: *.webm + Disallow: *.ogg + Disallow: *.avi + Disallow: *.mov + Disallow: *.wmv + Disallow: *.flv + Disallow: *.mkv + Disallow: *.py + Disallow: *.js + Disallow: *.java + Disallow: *.c + Disallow: *.cpp + Disallow: *.cs + Disallow: *.h + Disallow: *.css + Disallow: *.php + Disallow: *.swift + Disallow: *.go + Disallow: *.rb + Disallow: *.pl + Disallow: *.sh + Disallow: *.sql + +Host: https://gugulet.hu diff --git a/docs/src/gugulet.hu-combined-face-1276x1276.webp b/docs/src/gugulet.hu-combined-face-1276x1276.webp new file mode 100644 index 0000000..9576fe1 Binary files /dev/null and b/docs/src/gugulet.hu-combined-face-1276x1276.webp differ diff --git a/docs/src/gugulet.hu-site-logo-350x350.png b/docs/src/gugulet.hu-site-logo-350x350.png new file mode 100644 index 0000000..e10893f Binary files /dev/null and b/docs/src/gugulet.hu-site-logo-350x350.png differ diff --git a/docs/src/gugulet.hu-technical-face-1276x1276.webp b/docs/src/gugulet.hu-technical-face-1276x1276.webp new file mode 100644 index 0000000..5d58d21 Binary files /dev/null and b/docs/src/gugulet.hu-technical-face-1276x1276.webp differ diff --git a/docs/src/gugulet.hu-technical-face-1276x425.png b/docs/src/gugulet.hu-technical-face-1276x425.png new file mode 100644 index 0000000..6cd41c4 Binary files /dev/null and b/docs/src/gugulet.hu-technical-face-1276x425.png differ diff --git a/docs/src/gugulet.hu-unedited-face-1276x1276.webp b/docs/src/gugulet.hu-unedited-face-1276x1276.webp new file mode 100644 index 0000000..cbc5ec0 Binary files /dev/null and b/docs/src/gugulet.hu-unedited-face-1276x1276.webp differ diff --git a/docs/src/gugulet.hu-visual-face-1276x1276 copy.webp b/docs/src/gugulet.hu-visual-face-1276x1276 copy.webp new file mode 100644 index 0000000..0c3d1bd Binary files /dev/null and b/docs/src/gugulet.hu-visual-face-1276x1276 copy.webp differ diff --git a/docs/src/gugulet.hu-visual-face-1276x1276.webp b/docs/src/gugulet.hu-visual-face-1276x1276.webp new file mode 100644 index 0000000..0c3d1bd Binary files /dev/null and b/docs/src/gugulet.hu-visual-face-1276x1276.webp differ diff --git a/docs/src/gugulet.hu-visual-face-1276x425.png b/docs/src/gugulet.hu-visual-face-1276x425.png new file mode 100644 index 0000000..4ea9b88 Binary files /dev/null and b/docs/src/gugulet.hu-visual-face-1276x425.png differ diff --git a/docs/src/gugulet.hu-writing-face-1276x1276.webp b/docs/src/gugulet.hu-writing-face-1276x1276.webp new file mode 100644 index 0000000..aa4950e Binary files /dev/null and b/docs/src/gugulet.hu-writing-face-1276x1276.webp differ diff --git a/docs/src/gugulet.hu-writing-face-1276x425.png b/docs/src/gugulet.hu-writing-face-1276x425.png new file mode 100644 index 0000000..c8086f1 Binary files /dev/null and b/docs/src/gugulet.hu-writing-face-1276x425.png differ diff --git a/docs/src/js/index-text.js b/docs/src/js/index-text.js new file mode 100644 index 0000000..ce53e22 --- /dev/null +++ b/docs/src/js/index-text.js @@ -0,0 +1,11 @@ +document.getElementById('visual-hover').onmouseover = function () { + document.getElementById('hover-text').innerHTML = "a thousand words at a time"; +}; + +document.getElementById('technical-hover').onmouseover = function () { + document.getElementById('hover-text').innerHTML = "in zeroes, ones, and other numbers"; +}; + +document.getElementById('writing-hover').onmouseover = function () { + document.getElementById('hover-text').innerHTML = "letter by letter, word by word"; +}; diff --git a/docs/src/js/loader.js b/docs/src/js/loader.js new file mode 100644 index 0000000..34718aa --- /dev/null +++ b/docs/src/js/loader.js @@ -0,0 +1,12 @@ +document.getElementById('loader').style.display = 'block'; + +function fadeOutLoader() { + const loader = document.getElementById('loader'); + loader.classList.add('fade-out'); + + setTimeout(() => { + loader.remove(); + }, 1000); +} + +setTimeout(fadeOutLoader, 2500); diff --git a/docs/src/stylesheets/_colours.css b/docs/src/stylesheets/_colours.css new file mode 100644 index 0000000..a804ef9 --- /dev/null +++ b/docs/src/stylesheets/_colours.css @@ -0,0 +1,22 @@ +/* Change the colours of the root colour scheme */ +:root { + --background: #FAF9F6; + --md-primary-fg-color: #323036; + --md-primary-fg-color--light: #818589; + --md-primary-fg-color--dark: #323036; + --md-primary-bg-color: #FAF9F6; + --md-footer-bg-color: transparent; + --md-default-bg-color: #EFE5DC; +} + +[data-md-color-scheme=default] { + --md-default-bg-color: #FAF9F6; +} + +/* Edit the indigo accent colour scheme (no grey colour scheme) */ +[data-md-color-accent=indigo] { + --md-primary-fg-color: #323036; + --md-primary-fg-color--light: var(--md-primary-bg-color); + --md-primary-fg-color--dark: var(--md-primary-fg-color--dark); + --md-accent-fg-color: #323036; +} diff --git a/docs/src/stylesheets/g.css b/docs/src/stylesheets/g.css new file mode 100644 index 0000000..3bc0e96 --- /dev/null +++ b/docs/src/stylesheets/g.css @@ -0,0 +1,118 @@ +@import "_colours.css"; +@import url("https: //api.fonts.coollabs.io/css2?family=Lato:wght@300;400;700;900&family=Libre+Baskerville&family=DM+Mono:wght@400;500&display=swap"); + +/* Body background colour */ + +body { + background: transparent; +} + +/* Link colours */ +a { + color: var(--md-primary-fg-color--light); +} + +a:hover { + color: var(--md-primary-fg-color--dark); + text-decoration: none !important; +} + +/* Bold headings */ + +h1, +h2, +h3, +h4, +h5 { + font-weight: bold !important; +} + +h1 { + color: var(--md-primary-fg-color--dark) !important +} + +/* Paragraph font-size */ +.md-typeset { + font-size: .7rem; +} + +/* Remove the shadow under the header */ +.md-header--shadow { + box-shadow: none; +} + +/* Make the logo in the header larger */ +.md-header__button.md-logo img, +.md-header__button.md-logo svg { + height: 2.5rem; +} + +/* Do not display the site title in the header */ +.md-header__topic:first-child { + display: none; +} + +/* Use dark colour for the navigation links */ +.md-typeset a, +.md-nav__item .md-nav__link--active { + color: var(--md-primary-fg-color--dark); +} + +/* Underline links in text on hover an focus */ +.md-typeset a:focus, +.md-typeset a:hover { + text-decoration: underline; +} + +/* Change the colour of links on hover and focus */ +.md-nav__link:focus, +.md-nav__link:hover, +.md-typeset .headerlink:focus, +.md-typeset .headerlink:hover, +.md-typeset :target>.headerlink { + color: var(--md-primary-bg-color); +} + +html .md-footer-meta.md-typeset a, +.md-copyright__highlight { + color: var(--md-primary-bg-color); +} + +html .md-footer-meta.md-typeset a:hover, +html .md-footer-meta.md-typeset a:focus { + color: var(--md-primary-fg-color--dark); +} + +/* Make the footer background white and the content dark */ +.md-footer, +.md-footer-meta { + background-color: var(--md-primary-fg-color); + color: var(--md-primary-bg-color); +} + +/* Change colour of search highlighting */ + +.md-search-result__link:focus, +.md-search-result__link:hover { + background-color: #E6E6E6; +} + +.md-typeset mark { + background-color: var(--md-accent-fg-color); +} + +/* Hide stars and forks in git section */ +li.md-source__fact.md-source__fact--stars, +li.md-source__fact.md-source__fact--forks { + display: none !important; +} + +/* Fixing admonitions */ + +.admonition { + border: none !important; +} + +.admonition>p:nth-child(2) { + background-color: white !important; +} diff --git a/docs/src/stylesheets/index.css b/docs/src/stylesheets/index.css new file mode 100644 index 0000000..99fc32f --- /dev/null +++ b/docs/src/stylesheets/index.css @@ -0,0 +1,213 @@ +@import url(_colours.css); +@import url("https: //api.fonts.coollabs.io/css2?family=Lato:wght@300;400;700;900&family=Libre+Baskerville&family=DM+Mono:wght@400;500&display=swap"); + +header, +nav, +footer, +.md-content .md-typeset h1 { + display: none !important; +} + +article, +.md-container { + min-height: 100vh; + width: 100%; + margin: 0; + padding: 0; +} + +.md-content__inner, +.md-main__inner, +.md-grid, +html, +body, +* { + margin: 0; + padding: 0; + box-sizing: border-box; +} + +.md-grid { + max-width: none; +} + +/* This was creating an annoying space at the top */ +article.md-content__inner.md-typeset:before, +article.md-content__inner.md-typeset:after { + content: none; +} + +body { + min-height: 100vh; + display: flex; + justify-content: center; + align-items: center; + background-color: white; + width: 100%; +} + +.container { + width: 100%; + height: 100%; +} + +.columns { + display: flex; + justify-content: space-between; + width: 100%; + height: 50vh; +} + +.top-row { + flex: 1; + min-width: 100vw; + height: 50vh; + display: flex; + flex-direction: row; + justify-content: center; + padding: 5em; + font-family: 'Libre Baskerville', serif; +} + +.top-row h2 { + margin-bottom: 0.1em; + font-size: 5vw; + font-weight: 900; + overflow: hidden; + border-right: .15em solid #818589; + white-space: nowrap; + letter-spacing: .05em; + animation: + typing 5s steps(40, end) forwards 2s, + blink-caret 0.75s step-end infinite; +} + +@keyframes typing { + from { + width: 0 + } + + to { + width: 100% + } +} + +@keyframes blink-caret { + + from, + to { + border-color: transparent; + } + + 50% { + border-color: #818589; + } +} + +.top-row p { + font-size: 3vw; + color: #818589; +} + +.top-row * { + text-align: left; +} + +/* Image Container Styling */ +.image-container { + width: 100%; + height: 33.33vh; + position: relative; + overflow: hidden; +} + +.image-container:hover { + filter: invert(50%); +} + +.image-container img { + width: 100%; + height: 100%; + object-fit: contain; +} + +/* Responsive Design */ +@media (max-width: 768px) { + .columns { + flex-direction: column; + } +} + +#loader { + position: fixed; + top: 0; + left: 0; + width: 100vw; + height: 100vh; + background-color: #EFE5DC; + display: flex !important; + justify-content: center; + align-items: center; + z-index: 9998; + transition: opacity 1s ease-out, transform 0.5s ease-out; +} + +#loader.fade-out { + opacity: 0; + transform: scale(1.1); +} + +#loader img { + width: 50px; + height: 50px; + +} + +@keyframes spin { + from { + transform: rotate(0deg); + } + + to { + transform: rotate(360deg); + } +} + +#loading-text { + font-family: Arial, sans-serif; + font-size: 24px; + color: black; + /* Change text color if needed */ + animation: pulse 1s ease-in-out infinite; +} + +@keyframes pulse { + 0% { + opacity: 1; + } + + 50% { + opacity: 0.5; + } + + 100% { + opacity: 1; + } +} + +/* Add fade-out animation */ +@keyframes fadeOut { + from { + opacity: 1; + transform: scale(1); + } + + to { + opacity: 0; + transform: scale(1.1); + } +} + +.fade-out { + animation: fadeOut 1s ease-out forwards; +} diff --git a/docs/src/stylesheets/index2.css b/docs/src/stylesheets/index2.css new file mode 100644 index 0000000..a11edd6 --- /dev/null +++ b/docs/src/stylesheets/index2.css @@ -0,0 +1,104 @@ +@import url(_colours.css); + +header, +nav, +footer, +.md-content .md-typeset h1 { + display: none !important; +} + +* { + margin: 0; + padding: 0; + box-sizing: border-box; +} + +html { + min-height: 100vh; + width: 100%; +} + +body { + background-color: white; + height: 100%; + font-family: 'Lato', sans-serif; + font-weight: bold; + margin: 0; + padding: 0; + box-sizing: border-box; +} + +.md-grid { + max-width: 100vw; + margin: 0; + padding: 0; +} + +.md-content__inner { + padding: 0; + margin: 0; +} + +.grid-container { + display: grid; + grid-template-columns: repeat(auto-fit, minmax(250px, 1fr)); + gap: 50px; + min-height: 95vh; + width: 100%; + padding: 0; +} + +.column { + position: relative; + width: 100%; + height: auto; + background-size: contain; + background-repeat: no-repeat; + background-position: center center; + transition: all 0.3s ease; + opacity: 0.5; +} + +.column:hover { + opacity: 1; + filter: invert(50%); +} + +.content { + position: static; + top: 0; + left: 0; + width: 100%; + height: 100%; + opacity: 0; + transition: all 0.3s ease; + color: var(--md-primary-fg-color); + display: flex; + align-items: center; + justify-content: center; + text-align: center; + z-index: 1; +} + +.column:hover .content { + opacity: 0; + animation: fadeIn 1s ease-out forwards; +} + +@keyframes fadeIn { + from { + opacity: 0; + } + + to { + opacity: 1; + } +} + +div.content>div { + margin: 0; + font-size: 1.5em; + color: var(--md-primary-fg-color); + padding: 8px; + font-size: 1.5em; +} diff --git a/docs/visual.md b/docs/visual.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/writing.md b/docs/writing.md new file mode 100644 index 0000000..e69de29 diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..f5f8389 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,216 @@ +copyright: '© Gugulethu Hlekwayo. All rights reserved.' + +exclude_docs: | + includes/ + overrides/ + readme.md + +extra: + generator: false + social: + - icon: material/web + link: https://gugulet.hu + - icon: material/git + link: https://codeberg.org/gugulethu + - icon: material/linkedin + link: https://www.linkedin.com/in/gugulet-hu + tags: + HTML: html + JavaScript: js + CSS: css + Python: python + Shell: shell + Manual: manual + Sync: sync + Logic: logic + Database: database + Collect: collect + Validate: validate + Display: display + Analyse: analyse + Predict: predict + Watch: watch + Mobile: mobile + Laptop: laptop + +extra_css: + - src/stylesheets/g.css + +markdown_extensions: + # Allows showing additional content on hover for glossaries. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/?h=abbr#abbreviations] + - abbr + # Allows the use of admonitions. [https://squidfunk.github.io/mkdocs-material/reference/admonitions/#admonitions] + - admonition + # Attribute lists. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/?h=attr+list#attribute-lists] + - attr_list + # Allows creating footonotes. [https://squidfunk.github.io/mkdocs-material/reference/footnotes/?h=footnotes#footnotes] + - footnotes + # Improves handling of emphasis in MarkDown. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/?h=bet#betterem] + - pymdownx.betterem: + smart_enable: all + # Enable carets in MarkDown. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/?h=bet#betterem] + - pymdownx.caret + # Makes admonitions collapsible. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#details] + - pymdownx.details + - pymdownx.emoji: + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg + # Allows code block highlighting. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/?h=highlig#highlight] + - pymdownx.highlight + # Built on pymdownx.highlight. Allows highlighting inline code. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/?h=inline#inlinehilite] + - pymdownx.inlinehilite + # Add keyboard keys in Markdown. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/?h=inline#keys] + - pymdownx.keys + # Allows highlight text in MarkDown. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/?h=bet#betterem] + - pymdownx.mark + # Add smart symbols, like copyright, in MarkDown. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/?h=smartsym#smartsymbols] + - pymdownx.smartsymbols + # Embed content and show it as a tooltip, liek for the definitions. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/?h=smartsym#snippets] + - pymdownx.snippets: + auto_append: + - includes/definitions.md # Path to definitions that appear in windows in the text. + # Used to target Mermaid diagrams for rendering. [https://squidfunk.github.io/mkdocs-material/upgrade/?h=superfen#pymdownxsuperfences] + - pymdownx.superfences: + custom_fences: + - name: mermaid + class: mermaid + format: !!python/name:mermaid2.fence_mermaid_custom + # Allows creating content tabs. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/?h=tabb#tabbed] + - pymdownx.tabbed: + alternate_style: true # This is the supported style. Works better on mobile view. + # Render tasklists with custom icons. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/?h=taskl#tasklist] + - pymdownx.tasklist: + custom_checkbox: true + #Allows tildes in MarkDown. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/?h=bet#betterem] + - pymdownx.tilde + - toc: + permalink: false + toc_depth: 2 + +nav: + - Homepage: index.md + - Writing: writing.md + - Visual: visual.md + - Code and Data: + - code-data.md + - Qself: + - qself/qself.md + - Getting started: qself/getting-started.md + - Finances: qself/finances.md + - Transactions: qself/transactions.md + - Reference: qself/reference/index.md + - Devices: qself/devices.md + - Resumé: resume.md + +plugins: + # Plugin to display a lightbox for clicked images. [https://github.com/Blueswen/mkdocs-glightbox] + - glightbox: + background: white + shadow: false + width: 100% + height: auto + slide_effect: fade + skip_classes: + - skip-lightbox + # Plugin to use variables and macros across the docs. [https://github.com/fralau/mkdocs-macros-plugin] + - macros: + on_undefined: strict + include_yaml: + - snippets: docs/includes/snippets.yml + # Plugin to display mermaid diagrams. [https://mkdocs-mermaid2.readthedocs.io/en/latest/] + - mermaid2 + # Plugin that minifies all HTML, CSS, and JS files. [https://github.com/byrnereese/mkdocs-minify-plugin] + - minify: + minify_html: true + minify_js: true + minify_css: true + htmlmin_opts: + remove_comments: true + cache_safe: true + # Plugin to self-host external assets and for link attributes. [https://squidfunk.github.io/mkdocs-material/plugins/privacy/] + - privacy: + links_attr_map: + target: _blank # Open external links in a new page. + assets_exclude: + - cdn.jsdelivr.net/npm/mathjax@3/* + - search + # Plugin to create index pages for each section. [https://github.com/oprypin/mkdocs-section-index] + - section-index + # Plugin to manage social media cards. Requires installing: pip install "mkdocs-material[imaging] + - social: + cards: true + cards_layout_options: + background_color: "#828089" + font_family: Libre Baskerville + - tags + +repo_name: gugulet-hu/gugulet.hu + +repo_url: https://codeberg.com/gugulethu/gugulet-hu + +site_author: Gugulethu Hlekwayo (https://codeberg.org/gugulethu) + +site_description: The personal website of Gugulethu Hlekwayo. + +site_name: Gugulethu Hlekwayo + +site_url: 'https://gugulet.hu' + +theme: + # Folder where there are files that override aspects of the site. + custom_dir: docs/overrides/ + # Link to the favicon image file. + favicon: src/gugulet.hu-site-logo-350x350.png + features: + - content.action.edit # Edit page directly from the GitHub link iun the top-right. + - content.code.annotate # Annotate code blocks. + - content.code.copy # Copy code blocks. + - content.code.select # Select code range in blocks (*). + - navigation.expand # Expand the navigation by default. + - navigation.path # Add breadcrumbs to the top of the article. + - navigation.prune # Only the visible pages are in the menu. + - navigation.tabs # Tabs at the top for the chapters (i.e Platform Admin, Platform Tools, ...). + - navigation.tracking # Address bar updated with active anchor. + - navigation.top # Back to the top button on every page. + - navigation.footer # Previous and next buttons in the footer. + - search.highlight # Highlight the search item in the page. + - search.suggest # Suggest search results. + - search.share # Deep-link to a search results page. + font: + text: Libre Baskerville + code: DM Mono + # Icons to use for different tags and the repo. + icon: + repo: material/git + tag: + analyse: material/finance + collect: material/collapse-all + css: material/language-css3 + database: material/database + display: material/fit-to-screen + html: material/language-html5 + js: material/language-javascript + laptop: material/laptop + logic: material/robot + manual: material/wheel-barrow + mobile: material/cellphone-cog + predict: material/crystal-ball + python: material/language-python + shell: material/console + sync: material/sync-circle + validate: material/check-decagram + watch: material/watch + language: en + logo: src/gugulet.hu-site-logo-350x350.png + name: material + palette: + scheme: default + primary: custom + accent: indigo + +# Properties to validate and return messages for in the build process. +validation: + nav: + absolute_links: ignore + not_found: warn + omitted_files: ignore diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..401798a --- /dev/null +++ b/readme.md @@ -0,0 +1,7 @@ +# gugulet.hu + +This repo contains the files for maintaining my personal website: [gugulet.hu](https://gugulet.hu) and is built using the MkDocs Material static site generator. + +## Setting up local development + +The following tools are used for local development the diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..16a4858 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,54 @@ +babel>=2.16.0 +beautifulsoup4>=4.12.3 +cairocffi>=1.7.1 +CairoSVG>=2.7.1 +certifi>=2024.12.14 +cffi>=1.17.1 +charset-normalizer>=3.4.1 +click>=8.1.8 +colorama>=0.4.6 +csscompressor>=0.9.5 +cssselect2>=0.7.0 +defusedxml>=0.7.1 +EditorConfig>=0.17.0 +ghp-import>=2.1.0 +hjson>=3.1.0 +htmlmin2>=0.1.13 +idna>=3.10 +Jinja2>=3.1.5 +jsbeautifier>=1.15.1 +jsmin>=3.0.1 +Markdown>=3.7 +MarkupSafe>=3.0.2 +mergedeep>=1.3.4 +mkdocs>=1.6.1 +mkdocs-get-deps>=0.2.0 +mkdocs-glightbox>=0.4.0 +mkdocs-macros-plugin>=1.3.7 +mkdocs-material>=9.5.50 +mkdocs-material-extensions>=1.3.1 +mkdocs-mermaid2-plugin>=1.2.1 +mkdocs-minify-plugin>=0.8.0 +mkdocs-section-index>=0.3.9 +packaging>=24.2 +paginate>=0.5.7 +pathspec>=0.12.1 +pillow>=10.4.0 +platformdirs>=4.3.6 +pycparser>=2.22 +Pygments>=2.19.1 +pymdown-extensions>=10.14 +python-dateutil>=2.9.0.post0 +PyYAML>=6.0.2 +pyyaml_env_tag>=0.1 +regex>=2024.11.6 +requests>=2.32.3 +setuptools>=75.8.0 +six>=1.17.0 +soupsieve>=2.6 +super_collections>=0.5.3 +termcolor>=2.5.0 +tinycss2>=1.4.0 +urllib3>=2.3.0 +watchdog>=6.0.0 +webencodings>=0.5.1 diff --git a/styles/Google/AMPM.yml b/styles/Google/AMPM.yml new file mode 100644 index 0000000..37b49ed --- /dev/null +++ b/styles/Google/AMPM.yml @@ -0,0 +1,9 @@ +extends: existence +message: "Use 'AM' or 'PM' (preceded by a space)." +link: "https://developers.google.com/style/word-list" +level: error +nonword: true +tokens: + - '\d{1,2}[AP]M\b' + - '\d{1,2} ?[ap]m\b' + - '\d{1,2} ?[aApP]\.[mM]\.' diff --git a/styles/Google/Acronyms.yml b/styles/Google/Acronyms.yml new file mode 100644 index 0000000..f41af01 --- /dev/null +++ b/styles/Google/Acronyms.yml @@ -0,0 +1,64 @@ +extends: conditional +message: "Spell out '%s', if it's unfamiliar to the audience." +link: 'https://developers.google.com/style/abbreviations' +level: suggestion +ignorecase: false +# Ensures that the existence of 'first' implies the existence of 'second'. +first: '\b([A-Z]{3,5})\b' +second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)' +# ... with the exception of these: +exceptions: + - API + - ASP + - CLI + - CPU + - CSS + - CSV + - DEBUG + - DOM + - DPI + - FAQ + - GCC + - GDB + - GET + - GPU + - GTK + - GUI + - HTML + - HTTP + - HTTPS + - IDE + - JAR + - JSON + - JSX + - LESS + - LLDB + - NET + - NOTE + - NVDA + - OSS + - PATH + - PDF + - PHP + - POST + - RAM + - REPL + - RSA + - SCM + - SCSS + - SDK + - SQL + - SSH + - SSL + - SVG + - TBD + - TCP + - TODO + - URI + - URL + - USB + - UTF + - XML + - XSS + - YAML + - ZIP diff --git a/styles/Google/Colons.yml b/styles/Google/Colons.yml new file mode 100644 index 0000000..4a027c3 --- /dev/null +++ b/styles/Google/Colons.yml @@ -0,0 +1,8 @@ +extends: existence +message: "'%s' should be in lowercase." +link: 'https://developers.google.com/style/colons' +nonword: true +level: warning +scope: sentence +tokens: + - '(?=1.0.0" +} diff --git a/styles/Google/vocab.txt b/styles/Google/vocab.txt new file mode 100644 index 0000000..e69de29 diff --git a/styles/write-good/Cliches.yml b/styles/write-good/Cliches.yml new file mode 100644 index 0000000..c953143 --- /dev/null +++ b/styles/write-good/Cliches.yml @@ -0,0 +1,702 @@ +extends: existence +message: "Try to avoid using clichés like '%s'." +ignorecase: true +level: warning +tokens: + - a chip off the old block + - a clean slate + - a dark and stormy night + - a far cry + - a fine kettle of fish + - a loose cannon + - a penny saved is a penny earned + - a tough row to hoe + - a word to the wise + - ace in the hole + - acid test + - add insult to injury + - against all odds + - air your dirty laundry + - all fun and games + - all in a day's work + - all talk, no action + - all thumbs + - all your eggs in one basket + - all's fair in love and war + - all's well that ends well + - almighty dollar + - American as apple pie + - an axe to grind + - another day, another dollar + - armed to the teeth + - as luck would have it + - as old as time + - as the crow flies + - at loose ends + - at my wits end + - avoid like the plague + - babe in the woods + - back against the wall + - back in the saddle + - back to square one + - back to the drawing board + - bad to the bone + - badge of honor + - bald faced liar + - ballpark figure + - banging your head against a brick wall + - baptism by fire + - barking up the wrong tree + - bat out of hell + - be all and end all + - beat a dead horse + - beat around the bush + - been there, done that + - beggars can't be choosers + - behind the eight ball + - bend over backwards + - benefit of the doubt + - bent out of shape + - best thing since sliced bread + - bet your bottom dollar + - better half + - better late than never + - better mousetrap + - better safe than sorry + - between a rock and a hard place + - beyond the pale + - bide your time + - big as life + - big cheese + - big fish in a small pond + - big man on campus + - bigger they are the harder they fall + - bird in the hand + - bird's eye view + - birds and the bees + - birds of a feather flock together + - bit the hand that feeds you + - bite the bullet + - bite the dust + - bitten off more than he can chew + - black as coal + - black as pitch + - black as the ace of spades + - blast from the past + - bleeding heart + - blessing in disguise + - blind ambition + - blind as a bat + - blind leading the blind + - blood is thicker than water + - blood sweat and tears + - blow off steam + - blow your own horn + - blushing bride + - boils down to + - bolt from the blue + - bone to pick + - bored stiff + - bored to tears + - bottomless pit + - boys will be boys + - bright and early + - brings home the bacon + - broad across the beam + - broken record + - brought back to reality + - bull by the horns + - bull in a china shop + - burn the midnight oil + - burning question + - burning the candle at both ends + - burst your bubble + - bury the hatchet + - busy as a bee + - by hook or by crook + - call a spade a spade + - called onto the carpet + - calm before the storm + - can of worms + - can't cut the mustard + - can't hold a candle to + - case of mistaken identity + - cat got your tongue + - cat's meow + - caught in the crossfire + - caught red-handed + - checkered past + - chomping at the bit + - cleanliness is next to godliness + - clear as a bell + - clear as mud + - close to the vest + - cock and bull story + - cold shoulder + - come hell or high water + - cool as a cucumber + - cool, calm, and collected + - cost a king's ransom + - count your blessings + - crack of dawn + - crash course + - creature comforts + - cross that bridge when you come to it + - crushing blow + - cry like a baby + - cry me a river + - cry over spilt milk + - crystal clear + - curiosity killed the cat + - cut and dried + - cut through the red tape + - cut to the chase + - cute as a bugs ear + - cute as a button + - cute as a puppy + - cuts to the quick + - dark before the dawn + - day in, day out + - dead as a doornail + - devil is in the details + - dime a dozen + - divide and conquer + - dog and pony show + - dog days + - dog eat dog + - dog tired + - don't burn your bridges + - don't count your chickens + - don't look a gift horse in the mouth + - don't rock the boat + - don't step on anyone's toes + - don't take any wooden nickels + - down and out + - down at the heels + - down in the dumps + - down the hatch + - down to earth + - draw the line + - dressed to kill + - dressed to the nines + - drives me up the wall + - dull as dishwater + - dyed in the wool + - eagle eye + - ear to the ground + - early bird catches the worm + - easier said than done + - easy as pie + - eat your heart out + - eat your words + - eleventh hour + - even the playing field + - every dog has its day + - every fiber of my being + - everything but the kitchen sink + - eye for an eye + - face the music + - facts of life + - fair weather friend + - fall by the wayside + - fan the flames + - feast or famine + - feather your nest + - feathered friends + - few and far between + - fifteen minutes of fame + - filthy vermin + - fine kettle of fish + - fish out of water + - fishing for a compliment + - fit as a fiddle + - fit the bill + - fit to be tied + - flash in the pan + - flat as a pancake + - flip your lid + - flog a dead horse + - fly by night + - fly the coop + - follow your heart + - for all intents and purposes + - for the birds + - for what it's worth + - force of nature + - force to be reckoned with + - forgive and forget + - fox in the henhouse + - free and easy + - free as a bird + - fresh as a daisy + - full steam ahead + - fun in the sun + - garbage in, garbage out + - gentle as a lamb + - get a kick out of + - get a leg up + - get down and dirty + - get the lead out + - get to the bottom of + - get your feet wet + - gets my goat + - gilding the lily + - give and take + - go against the grain + - go at it tooth and nail + - go for broke + - go him one better + - go the extra mile + - go with the flow + - goes without saying + - good as gold + - good deed for the day + - good things come to those who wait + - good time was had by all + - good times were had by all + - greased lightning + - greek to me + - green thumb + - green-eyed monster + - grist for the mill + - growing like a weed + - hair of the dog + - hand to mouth + - happy as a clam + - happy as a lark + - hasn't a clue + - have a nice day + - have high hopes + - have the last laugh + - haven't got a row to hoe + - head honcho + - head over heels + - hear a pin drop + - heard it through the grapevine + - heart's content + - heavy as lead + - hem and haw + - high and dry + - high and mighty + - high as a kite + - hit paydirt + - hold your head up high + - hold your horses + - hold your own + - hold your tongue + - honest as the day is long + - horns of a dilemma + - horse of a different color + - hot under the collar + - hour of need + - I beg to differ + - icing on the cake + - if the shoe fits + - if the shoe were on the other foot + - in a jam + - in a jiffy + - in a nutshell + - in a pig's eye + - in a pinch + - in a word + - in hot water + - in the gutter + - in the nick of time + - in the thick of it + - in your dreams + - it ain't over till the fat lady sings + - it goes without saying + - it takes all kinds + - it takes one to know one + - it's a small world + - it's only a matter of time + - ivory tower + - Jack of all trades + - jockey for position + - jog your memory + - joined at the hip + - judge a book by its cover + - jump down your throat + - jump in with both feet + - jump on the bandwagon + - jump the gun + - jump to conclusions + - just a hop, skip, and a jump + - just the ticket + - justice is blind + - keep a stiff upper lip + - keep an eye on + - keep it simple, stupid + - keep the home fires burning + - keep up with the Joneses + - keep your chin up + - keep your fingers crossed + - kick the bucket + - kick up your heels + - kick your feet up + - kid in a candy store + - kill two birds with one stone + - kiss of death + - knock it out of the park + - knock on wood + - knock your socks off + - know him from Adam + - know the ropes + - know the score + - knuckle down + - knuckle sandwich + - knuckle under + - labor of love + - ladder of success + - land on your feet + - lap of luxury + - last but not least + - last hurrah + - last-ditch effort + - law of the jungle + - law of the land + - lay down the law + - leaps and bounds + - let sleeping dogs lie + - let the cat out of the bag + - let the good times roll + - let your hair down + - let's talk turkey + - letter perfect + - lick your wounds + - lies like a rug + - life's a bitch + - life's a grind + - light at the end of the tunnel + - lighter than a feather + - lighter than air + - like clockwork + - like father like son + - like taking candy from a baby + - like there's no tomorrow + - lion's share + - live and learn + - live and let live + - long and short of it + - long lost love + - look before you leap + - look down your nose + - look what the cat dragged in + - looking a gift horse in the mouth + - looks like death warmed over + - loose cannon + - lose your head + - lose your temper + - loud as a horn + - lounge lizard + - loved and lost + - low man on the totem pole + - luck of the draw + - luck of the Irish + - make hay while the sun shines + - make money hand over fist + - make my day + - make the best of a bad situation + - make the best of it + - make your blood boil + - man of few words + - man's best friend + - mark my words + - meaningful dialogue + - missed the boat on that one + - moment in the sun + - moment of glory + - moment of truth + - money to burn + - more power to you + - more than one way to skin a cat + - movers and shakers + - moving experience + - naked as a jaybird + - naked truth + - neat as a pin + - needle in a haystack + - needless to say + - neither here nor there + - never look back + - never say never + - nip and tuck + - nip it in the bud + - no guts, no glory + - no love lost + - no pain, no gain + - no skin off my back + - no stone unturned + - no time like the present + - no use crying over spilled milk + - nose to the grindstone + - not a hope in hell + - not a minute's peace + - not in my backyard + - not playing with a full deck + - not the end of the world + - not written in stone + - nothing to sneeze at + - nothing ventured nothing gained + - now we're cooking + - off the top of my head + - off the wagon + - off the wall + - old hat + - older and wiser + - older than dirt + - older than Methuselah + - on a roll + - on cloud nine + - on pins and needles + - on the bandwagon + - on the money + - on the nose + - on the rocks + - on the spot + - on the tip of my tongue + - on the wagon + - on thin ice + - once bitten, twice shy + - one bad apple doesn't spoil the bushel + - one born every minute + - one brick short + - one foot in the grave + - one in a million + - one red cent + - only game in town + - open a can of worms + - open and shut case + - open the flood gates + - opportunity doesn't knock twice + - out of pocket + - out of sight, out of mind + - out of the frying pan into the fire + - out of the woods + - out on a limb + - over a barrel + - over the hump + - pain and suffering + - pain in the + - panic button + - par for the course + - part and parcel + - party pooper + - pass the buck + - patience is a virtue + - pay through the nose + - penny pincher + - perfect storm + - pig in a poke + - pile it on + - pillar of the community + - pin your hopes on + - pitter patter of little feet + - plain as day + - plain as the nose on your face + - play by the rules + - play your cards right + - playing the field + - playing with fire + - pleased as punch + - plenty of fish in the sea + - point with pride + - poor as a church mouse + - pot calling the kettle black + - pretty as a picture + - pull a fast one + - pull your punches + - pulling your leg + - pure as the driven snow + - put it in a nutshell + - put one over on you + - put the cart before the horse + - put the pedal to the metal + - put your best foot forward + - put your foot down + - quick as a bunny + - quick as a lick + - quick as a wink + - quick as lightning + - quiet as a dormouse + - rags to riches + - raining buckets + - raining cats and dogs + - rank and file + - rat race + - reap what you sow + - red as a beet + - red herring + - reinvent the wheel + - rich and famous + - rings a bell + - ripe old age + - ripped me off + - rise and shine + - road to hell is paved with good intentions + - rob Peter to pay Paul + - roll over in the grave + - rub the wrong way + - ruled the roost + - running in circles + - sad but true + - sadder but wiser + - salt of the earth + - scared stiff + - scared to death + - sealed with a kiss + - second to none + - see eye to eye + - seen the light + - seize the day + - set the record straight + - set the world on fire + - set your teeth on edge + - sharp as a tack + - shoot for the moon + - shoot the breeze + - shot in the dark + - shoulder to the wheel + - sick as a dog + - sigh of relief + - signed, sealed, and delivered + - sink or swim + - six of one, half a dozen of another + - skating on thin ice + - slept like a log + - slinging mud + - slippery as an eel + - slow as molasses + - smart as a whip + - smooth as a baby's bottom + - sneaking suspicion + - snug as a bug in a rug + - sow wild oats + - spare the rod, spoil the child + - speak of the devil + - spilled the beans + - spinning your wheels + - spitting image of + - spoke with relish + - spread like wildfire + - spring to life + - squeaky wheel gets the grease + - stands out like a sore thumb + - start from scratch + - stick in the mud + - still waters run deep + - stitch in time + - stop and smell the roses + - straight as an arrow + - straw that broke the camel's back + - strong as an ox + - stubborn as a mule + - stuff that dreams are made of + - stuffed shirt + - sweating blood + - sweating bullets + - take a load off + - take one for the team + - take the bait + - take the bull by the horns + - take the plunge + - takes one to know one + - takes two to tango + - the more the merrier + - the real deal + - the real McCoy + - the red carpet treatment + - the same old story + - there is no accounting for taste + - thick as a brick + - thick as thieves + - thin as a rail + - think outside of the box + - third time's the charm + - this day and age + - this hurts me worse than it hurts you + - this point in time + - three sheets to the wind + - through thick and thin + - throw in the towel + - tie one on + - tighter than a drum + - time and time again + - time is of the essence + - tip of the iceberg + - tired but happy + - to coin a phrase + - to each his own + - to make a long story short + - to the best of my knowledge + - toe the line + - tongue in cheek + - too good to be true + - too hot to handle + - too numerous to mention + - touch with a ten foot pole + - tough as nails + - trial and error + - trials and tribulations + - tried and true + - trip down memory lane + - twist of fate + - two cents worth + - two peas in a pod + - ugly as sin + - under the counter + - under the gun + - under the same roof + - under the weather + - until the cows come home + - unvarnished truth + - up the creek + - uphill battle + - upper crust + - upset the applecart + - vain attempt + - vain effort + - vanquish the enemy + - vested interest + - waiting for the other shoe to drop + - wakeup call + - warm welcome + - watch your p's and q's + - watch your tongue + - watching the clock + - water under the bridge + - weather the storm + - weed them out + - week of Sundays + - went belly up + - wet behind the ears + - what goes around comes around + - what you see is what you get + - when it rains, it pours + - when push comes to shove + - when the cat's away + - when the going gets tough, the tough get going + - white as a sheet + - whole ball of wax + - whole hog + - whole nine yards + - wild goose chase + - will wonders never cease? + - wisdom of the ages + - wise as an owl + - wolf at the door + - words fail me + - work like a dog + - world weary + - worst nightmare + - worth its weight in gold + - wrong side of the bed + - yanking your chain + - yappy as a dog + - years young + - you are what you eat + - you can run but you can't hide + - you only live once + - you're the boss + - young and foolish + - young and vibrant diff --git a/styles/write-good/E-Prime.yml b/styles/write-good/E-Prime.yml new file mode 100644 index 0000000..074a102 --- /dev/null +++ b/styles/write-good/E-Prime.yml @@ -0,0 +1,32 @@ +extends: existence +message: "Try to avoid using '%s'." +ignorecase: true +level: suggestion +tokens: + - am + - are + - aren't + - be + - been + - being + - he's + - here's + - here's + - how's + - i'm + - is + - isn't + - it's + - she's + - that's + - there's + - they're + - was + - wasn't + - we're + - were + - weren't + - what's + - where's + - who's + - you're diff --git a/styles/write-good/Illusions.yml b/styles/write-good/Illusions.yml new file mode 100644 index 0000000..b4f1321 --- /dev/null +++ b/styles/write-good/Illusions.yml @@ -0,0 +1,11 @@ +extends: repetition +message: "'%s' is repeated!" +level: warning +alpha: true +action: + name: edit + params: + - truncate + - " " +tokens: + - '[^\s]+' diff --git a/styles/write-good/Passive.yml b/styles/write-good/Passive.yml new file mode 100644 index 0000000..f472cb9 --- /dev/null +++ b/styles/write-good/Passive.yml @@ -0,0 +1,183 @@ +extends: existence +message: "'%s' may be passive voice. Use active voice if you can." +ignorecase: true +level: warning +raw: + - \b(am|are|were|being|is|been|was|be)\b\s* +tokens: + - '[\w]+ed' + - awoken + - beat + - become + - been + - begun + - bent + - beset + - bet + - bid + - bidden + - bitten + - bled + - blown + - born + - bought + - bound + - bred + - broadcast + - broken + - brought + - built + - burnt + - burst + - cast + - caught + - chosen + - clung + - come + - cost + - crept + - cut + - dealt + - dived + - done + - drawn + - dreamt + - driven + - drunk + - dug + - eaten + - fallen + - fed + - felt + - fit + - fled + - flown + - flung + - forbidden + - foregone + - forgiven + - forgotten + - forsaken + - fought + - found + - frozen + - given + - gone + - gotten + - ground + - grown + - heard + - held + - hidden + - hit + - hung + - hurt + - kept + - knelt + - knit + - known + - laid + - lain + - leapt + - learnt + - led + - left + - lent + - let + - lighted + - lost + - made + - meant + - met + - misspelt + - mistaken + - mown + - overcome + - overdone + - overtaken + - overthrown + - paid + - pled + - proven + - put + - quit + - read + - rid + - ridden + - risen + - run + - rung + - said + - sat + - sawn + - seen + - sent + - set + - sewn + - shaken + - shaven + - shed + - shod + - shone + - shorn + - shot + - shown + - shrunk + - shut + - slain + - slept + - slid + - slit + - slung + - smitten + - sold + - sought + - sown + - sped + - spent + - spilt + - spit + - split + - spoken + - spread + - sprung + - spun + - stolen + - stood + - stridden + - striven + - struck + - strung + - stuck + - stung + - stunk + - sung + - sunk + - swept + - swollen + - sworn + - swum + - swung + - taken + - taught + - thought + - thrived + - thrown + - thrust + - told + - torn + - trodden + - understood + - upheld + - upset + - wed + - wept + - withheld + - withstood + - woken + - won + - worn + - wound + - woven + - written + - wrung diff --git a/styles/write-good/README.md b/styles/write-good/README.md new file mode 100644 index 0000000..3edcc9b --- /dev/null +++ b/styles/write-good/README.md @@ -0,0 +1,27 @@ +Based on [write-good](https://github.com/btford/write-good). + +> Naive linter for English prose for developers who can't write good and wanna learn to do other stuff good too. + +``` +The MIT License (MIT) + +Copyright (c) 2014 Brian Ford + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. +``` diff --git a/styles/write-good/So.yml b/styles/write-good/So.yml new file mode 100644 index 0000000..e57f099 --- /dev/null +++ b/styles/write-good/So.yml @@ -0,0 +1,5 @@ +extends: existence +message: "Don't start a sentence with '%s'." +level: error +raw: + - '(?:[;-]\s)so[\s,]|\bSo[\s,]' diff --git a/styles/write-good/ThereIs.yml b/styles/write-good/ThereIs.yml new file mode 100644 index 0000000..8b82e8f --- /dev/null +++ b/styles/write-good/ThereIs.yml @@ -0,0 +1,6 @@ +extends: existence +message: "Don't start a sentence with '%s'." +ignorecase: false +level: error +raw: + - '(?:[;-]\s)There\s(is|are)|\bThere\s(is|are)\b' diff --git a/styles/write-good/TooWordy.yml b/styles/write-good/TooWordy.yml new file mode 100644 index 0000000..275701b --- /dev/null +++ b/styles/write-good/TooWordy.yml @@ -0,0 +1,221 @@ +extends: existence +message: "'%s' is too wordy." +ignorecase: true +level: warning +tokens: + - a number of + - abundance + - accede to + - accelerate + - accentuate + - accompany + - accomplish + - accorded + - accrue + - acquiesce + - acquire + - additional + - adjacent to + - adjustment + - admissible + - advantageous + - adversely impact + - advise + - aforementioned + - aggregate + - aircraft + - all of + - all things considered + - alleviate + - allocate + - along the lines of + - already existing + - alternatively + - amazing + - ameliorate + - anticipate + - apparent + - appreciable + - as a matter of fact + - as a means of + - as far as I'm concerned + - as of yet + - as to + - as yet + - ascertain + - assistance + - at the present time + - at this time + - attain + - attributable to + - authorize + - because of the fact that + - belated + - benefit from + - bestow + - by means of + - by virtue of + - by virtue of the fact that + - cease + - close proximity + - commence + - comply with + - concerning + - consequently + - consolidate + - constitutes + - demonstrate + - depart + - designate + - discontinue + - due to the fact that + - each and every + - economical + - eliminate + - elucidate + - employ + - endeavor + - enumerate + - equitable + - equivalent + - evaluate + - evidenced + - exclusively + - expedite + - expend + - expiration + - facilitate + - factual evidence + - feasible + - finalize + - first and foremost + - for all intents and purposes + - for the most part + - for the purpose of + - forfeit + - formulate + - have a tendency to + - honest truth + - however + - if and when + - impacted + - implement + - in a manner of speaking + - in a timely manner + - in a very real sense + - in accordance with + - in addition + - in all likelihood + - in an effort to + - in between + - in excess of + - in lieu of + - in light of the fact that + - in many cases + - in my opinion + - in order to + - in regard to + - in some instances + - in terms of + - in the case of + - in the event that + - in the final analysis + - in the nature of + - in the near future + - in the process of + - inception + - incumbent upon + - indicate + - indication + - initiate + - irregardless + - is applicable to + - is authorized to + - is responsible for + - it is + - it is essential + - it seems that + - it was + - magnitude + - maximum + - methodology + - minimize + - minimum + - modify + - monitor + - multiple + - necessitate + - nevertheless + - not certain + - not many + - not often + - not unless + - not unlike + - notwithstanding + - null and void + - numerous + - objective + - obligate + - obtain + - on the contrary + - on the other hand + - one particular + - optimum + - overall + - owing to the fact that + - participate + - particulars + - pass away + - pertaining to + - point in time + - portion + - possess + - preclude + - previously + - prior to + - prioritize + - procure + - proficiency + - provided that + - purchase + - put simply + - readily apparent + - refer back + - regarding + - relocate + - remainder + - remuneration + - requirement + - reside + - residence + - retain + - satisfy + - shall + - should you wish + - similar to + - solicit + - span across + - strategize + - subsequent + - substantial + - successfully complete + - sufficient + - terminate + - the month of + - the point I am trying to make + - therefore + - time period + - took advantage of + - transmit + - transpire + - type of + - until such time as + - utilization + - utilize + - validate + - various different + - what I mean to say is + - whether or not + - with respect to + - with the exception of + - witnessed diff --git a/styles/write-good/Weasel.yml b/styles/write-good/Weasel.yml new file mode 100644 index 0000000..d1d90a7 --- /dev/null +++ b/styles/write-good/Weasel.yml @@ -0,0 +1,29 @@ +extends: existence +message: "'%s' is a weasel word!" +ignorecase: true +level: warning +tokens: + - clearly + - completely + - exceedingly + - excellent + - extremely + - fairly + - huge + - interestingly + - is a number + - largely + - mostly + - obviously + - quite + - relatively + - remarkably + - several + - significantly + - substantially + - surprisingly + - tiny + - usually + - various + - vast + - very diff --git a/styles/write-good/meta.json b/styles/write-good/meta.json new file mode 100644 index 0000000..a115d28 --- /dev/null +++ b/styles/write-good/meta.json @@ -0,0 +1,4 @@ +{ + "feed": "https://github.com/errata-ai/write-good/releases.atom", + "vale_version": ">=1.0.0" +}