diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 16eebf6..36e8938 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -34,7 +34,9 @@ jobs: python-version: ${{ matrix.python-version }} - name: Install dependencies - run: pip install hatch + run: | + python -m pip install --upgrade pip + pip install hatch - name: Run Checks run: make checks diff --git a/.gitignore b/.gitignore index f3aae86..6bfce93 100644 --- a/.gitignore +++ b/.gitignore @@ -85,8 +85,7 @@ celerybeat-schedule .env # virtualenv -.venv -venv/ +*venv/ ENV/ # Spyder project settings diff --git a/Makefile b/Makefile index a576641..42b7995 100644 --- a/Makefile +++ b/Makefile @@ -1,10 +1,7 @@ .DEFAULT_GOAL := install # default command to run with just `make` .PHONY: build publish package coverage test lint docs -env-default : - hatch shell default - -env-clean : +env-prune : hatch env prune env-show : @@ -15,13 +12,16 @@ hatch-docs-deps-sync: sync-default: hatch run default:deps + sync-dev: hatch run dev:deps + sync-docs: hatch run docs:deps -sync : sync-default sync-dev sync-docs hatch-docs-deps-sync - echo "DONE.\n==========================" +# Sync only happens when we change something in deps array +# to simulate we can add a dependency 'cowsay' to a env and sync +sync : sync-default sync-dev sync-docs hatch-docs-deps-sync lint # install cli in local for testing, change code an it will be automatically reflected in UI install: diff --git a/README.md b/README.md index b888164..bf6cdb7 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,15 @@ # hckr - cli hack for developers [![PyPI - Version](https://img.shields.io/pypi/v/hckr.svg)](https://pypi.org/project/hckr) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/hckr.svg)](https://pypi.org/project/hckr) -[![Build](https://github.com/hckr-cli/hckr/actions/workflows/build.yml/badge.svg)](https://github.com/hckr-cli/hckr/actions/workflows/build.yml) +[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=hckr-cli_hckr&metric=coverage)](https://sonarcloud.io/summary/new_code?id=hckr-cli_hckr) +[![Quality gate](https://sonarcloud.io/api/project_badges/quality_gate?project=hckr-cli_hckr)](https://sonarcloud.io/summary/new_code?id=hckr-cli_hckr) [![Dependabot](https://github.com/hckr-cli/hckr/actions/workflows/dependabot/dependabot-updates/badge.svg)](https://github.com/hckr-cli/hckr/actions/workflows/dependabot/dependabot-updates) -[![CodeQL](https://github.com/hckr-cli/hckr/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/hckr-cli/hckr/actions/workflows/github-code-scanning/codeql) -[![codecov](https://codecov.io/gh/hckr-cli/hckr/branch/main/graph/badge.svg)](https://codecov.io/gh/hckr-cli/hckr) -[![GitHub commit activity](https://img.shields.io/github/commit-activity/m/hckr-cli/hckr)](https://github.com/hckr-cli/hckr/graphs/commit-activity) -[![GitHub contributors](https://img.shields.io/github/contributors/hckr-cli/hckr)](https://github.com/hckr-cli/hckr/graphs/contributors) +[![Build](https://github.com/hckr-cli/hckr/actions/workflows/build.yml/badge.svg)](https://github.com/hckr-cli/hckr/actions/workflows/build.yml) +[![Documentation Status](https://readthedocs.org/projects/hckr/badge/?version=latest)](https://hckr.readthedocs.io/en/latest/?badge=latest) + +[![SonarCloud](https://sonarcloud.io/images/project_badges/sonarcloud-orange.svg)](https://sonarcloud.io/summary/new_code?id=hckr-cli_hckr) + +[//]: # ([![GitHub commit activity](https://img.shields.io/github/commit-activity/m/hckr-cli/hckr)](https://github.com/hckr-cli/hckr/graphs/commit-activity)) ## Introduction @@ -28,11 +31,15 @@ If you feel awesome and want to support us in a small way, please consider starr - [Sponsors](#sponsors) ## Installation - +* using HomeBrew +```console +brew tap hckr-cli/tap +brew install hckr +``` +* using pip ```console pip install hckr ``` - ## License `hckr` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license. diff --git a/docs/source/_templates/components/nav-versions.html b/docs/source/_templates/components/nav-versions.html new file mode 100644 index 0000000..8605c2c --- /dev/null +++ b/docs/source/_templates/components/nav-versions.html @@ -0,0 +1 @@ + diff --git a/docs/source/_templates/partials/foot-socials.html b/docs/source/_templates/partials/foot-socials.html new file mode 100644 index 0000000..da3c0c1 --- /dev/null +++ b/docs/source/_templates/partials/foot-socials.html @@ -0,0 +1,32 @@ +
+ {%- include "components/foot-socials.html" -%} + + + + + + + + + + + + + +
diff --git a/docs/source/conf.py b/docs/source/conf.py index e142505..c56b866 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -48,6 +48,11 @@ "url": "https://pypi.org/project/hckr/", "external": "true" }, + { + "title": "Join our Slack", + "url": "https://join.slack.com/t/hckr-cli/shared_invite/zt-2kpwz39dw-CIVDcv1nGhEnQNLumJxJDQ", + "external": "true" + }, ], "light_logo": "_static/hckr-logo-black.png", "dark_logo": "_static/hckr-logo-white.png", diff --git a/pyproject.toml b/pyproject.toml index 740920b..3453fcf 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -53,6 +53,7 @@ Source = "https://github.com/hckr-cli/hckr" [tool.hatch.envs.default] type = "virtual" path = "venv" +python = "3.8" [tool.hatch.envs.default.scripts] deps = "echo 'Syncing Default Dependencies\n=========================='"