icons: added and other enhancements

.github/labeler.yml

@@ -1,9 +1,9 @@
 # Add 'label1' to any changes within 'example' folder or any subfolders
-docs:
+documentation:
 - changed-files:
   - any-glob-to-any-file: docs/**
 
-deps:
+project-config:
 - changed-files:
   - any-glob-to-any-file: pyproject.toml
 
@@ -15,10 +15,37 @@ github-actions:
 - changed-files:
   - any-glob-to-any-file: .github/**
 
-core:
+enhancement:
 - changed-files:
   - any-glob-to-any-file: src/**
 
 # Add 'feature' label to any PR where the head branch name starts with `feature` or has a `feature` section in the name
 feature:
  - head-branch: ['^feature', 'feature']
+
+fix:
+ - head-branch: ['^fix', 'fix']
+
+release:
+- changed-files:
+  - any-glob-to-any-file: src/hckr/__about__.py
+
+crypto:
+- changed-files:
+  - any-glob-to-any-file: src/hckr/cli/crypto/**
+
+cron:
+- changed-files:
+  - any-glob-to-any-file: src/hckr/cli/cron.py
+
+data:
+- changed-files:
+  - any-glob-to-any-file: src/hckr/cli/data.py
+
+hash:
+- changed-files:
+  - any-glob-to-any-file: src/hckr/cli/hash.py
+
+utils:
+- changed-files:
+  - any-glob-to-any-file: src/hckr/cli/utils/**

.gitignore

@@ -117,3 +117,4 @@ output.txt
 # faker outputs
 output/
 !output/.gitkeep
+_build/

.readthedocs.yaml

@@ -19,3 +19,4 @@ python:
   install:
     - method: pip
       path: .
+    - requirements: docs/requirements.txt

Makefile

@@ -10,8 +10,10 @@ env-clean :
 env-show :
 	hatch env show
 
+hatch-docs-deps-sync:
+	python docs/hatch-env-docs-requirements-sync.py
 # this will sync the dependencies automatically
-sync :
+sync : hatch-docs-deps-sync
 	hatch run cowsay -t "Syncing Dependencies" && echo "Synced.\n============="
 
 # install cli in local for testing, change code an it will be automatically reflected in UI
@@ -68,5 +70,5 @@ docs-build:
 	cd docs/ && make clean && make html && cd ..
 
 docs:
-	hatch run dev:docs
+	hatch run docs:docs
 

docs/hatch-env-docs-requirements-sync.py

@@ -0,0 +1,39 @@
+import tomli
+
+# this is needed as we want to use hatch.docs env for all doc dependencies
+# but readthedocs can't use hatch env and we have to either provide setup.py or requirement.txt
+# using this script we are syncing requirements.txt from docs dependencies automatically
+# this is build as part of the `make sync` command
+
+def generate_requirements(hatch_env='docs'):
+    # Path to your pyproject.toml
+    toml_file_path = 'pyproject.toml'
+
+    try:
+        # Open and read the pyproject.toml file
+        with open(toml_file_path, 'rb') as toml_file:
+            toml_data = tomli.load(toml_file)
+
+        # Extract dependencies for the specific Hatch environment
+        dependencies = toml_data.get('tool', {}).get('hatch', {}).get('envs', {}).get(hatch_env, {}).get('dependencies',
+                                                                                                       [])
+
+        # Write dependencies to requirements.txt
+        if dependencies:
+            with open('docs/requirements.txt', 'w') as req_file:
+                for dependency in dependencies:
+                    req_file.write(f"{dependency}\n")
+            print("requirements.txt generated successfully.")
+        else:
+            print("No dependencies found for the specified environment.")
+
+    except FileNotFoundError as e:
+        print("The pyproject.toml file was not found.")
+        raise e
+    except Exception as e:
+        print(f"An error occurred: {e}")
+        raise e
+
+
+if __name__ == "__main__":
+    generate_requirements()

docs/requirements.txt

@@ -0,0 +1,8 @@
+sphinx-autobuild
+sphinx
+sphinx-docsearch
+sphinx-click
+shibuya
+sphinx-notfound-page
+sphinx-copybutton
+tomli

docs/source/_static/INFO.md

@@ -0,0 +1,2 @@
+# Logo
+* logos are created using template https://app.logomakr.com/2gTgc1

docs/source/conf.py

@@ -17,7 +17,7 @@
     'sphinx_click',
     'notfound.extension',
     'sphinx_docsearch',
-    'sphinx_copybutton'
+    'sphinx_copybutton',
 ]
 
 docsearch_app_id = "UM5HRVXATR"
@@ -33,14 +33,30 @@
 # html_theme = 'alabaster'
 html_theme = 'shibuya'
 html_static_path = ['_static']
+# favicons
+html_favicon = '_static/favicon.ico'
 
 # TODO: enhance it https://shibuya.lepture.com/install/
 html_theme_options = {
-    # "announcement": "The content of the announcement",
     "color_mode": "light",  # light or dark
     "github_url": "https://github.com/pateash/hckr",
     "discussion_url": "https://github.com/pateash/hckr/discussions",
     "globaltoc_expand_depth": 1,
+    "nav_links": [
+        {
+            "title": "pypi",
+            "url": "https://pypi.org/project/hckr/",
+            "external": "true"
+        },
+    ],
+    "light_logo": "_static/hckr-logo-black.png",
+    "dark_logo": "_static/hckr-logo-white.png",
+    # "accent_color": "red",
+    "announcement": """<div style="text-align: center;">
+        <div style="display: inline-block;">
+         Please support the project by starring it on <a href='https://github.com/pateash/hckr/' target="_blank">Github</a>
+        </div>
+    </div>""",
 }
 
 html_context = {

pyproject.toml

@@ -31,19 +31,12 @@ dependencies = [
     "cron-descriptor",
     "rich",
     "cryptography",
-    # docs
-    "sphinx",
-    "sphinx-docsearch",
-    "sphinx-click",
-    "shibuya",
-    "sphinx-notfound-page",
-    "sphinx-copybutton",
     "Faker",
     "pandas", #To manage data and save in CSV, Excel, and Parquet formats.
     "openpyxl", # For handling Excel files with Pandas.
     "xlrd",
     "pyarrow", # For saving data in Parquet format.
-    "fastavro" # For handling Avro file format.
+    "fastavro", # For handling Avro file format.
 ]
 
 [project.urls]
@@ -100,13 +93,26 @@ dependencies = [
     "coverage[toml]>=6.2",
     "pytest",
     "pypi-cleanup",
-    "sphinx-autobuild",
 ]
 [tool.hatch.envs.dev.scripts]
 lint = "black --check src/ tests/"
 fix = "black -v src/ tests/"
 check = "mypy --install-types --non-interactive {args:src/hckr tests}"
 cov-xml = "coverage xml"
 pypi-clean = "pypi-cleanup -u pateash -p hckr --do-it"
+
+
+[tool.hatch.envs.docs]
+dependencies = [
+    "sphinx-autobuild",
+    "sphinx",
+    "sphinx-docsearch",
+    "sphinx-click",
+    "shibuya",
+    "sphinx-notfound-page",
+    "sphinx-copybutton",
+    "tomli"
+]
+[tool.hatch.envs.docs.scripts]
 # --pre-build makes sure we get latest changes even if we modify something in
 docs = "sphinx-autobuild -a --port=0 --open-browser docs/source docs/build --watch src/hckr --pre-build 'rm -rf docs/build'"