Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme fix #56

Merged
merged 14 commits into from
Jul 2, 2024
Merged

Readme fix #56

Show file tree
Hide file tree
Changes from 13 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
8946741
org-move: done
pateash Jul 2, 2024
eac1bc9
org-move: done
pateash Jul 2, 2024
7a63848
readme: updated
pateash Jul 2, 2024
4c7fe10
Merge branch 'main' of https://github.com/pateash/hckr into org-move
pateash Jul 2, 2024
8a78ae2
Update README.md
pateash Jul 2, 2024
43a509f
readme: readthedocs added
pateash Jul 2, 2024
7d2ef3a
readme: readthedocs added
pateash Jul 2, 2024
5e6b188
readme: readthedocs added
pateash Jul 2, 2024
b831397
readme: readthedocs added
pateash Jul 2, 2024
de991bf
readme: readthedocs added
pateash Jul 2, 2024
123d239
readme: readthedocs added
pateash Jul 2, 2024
ab0f0c8
readme: readthedocs added
pateash Jul 2, 2024
fc2c092
comment added
pateash Jul 2, 2024
eef23f3
comment added
pateash Jul 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .github/workflows/build.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 1 addition & 2 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,7 @@ celerybeat-schedule
.env

# virtualenv
.venv
venv/
*venv/
ENV/

# Spyder project settings
Expand Down
12 changes: 6 additions & 6 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 :
Expand All @@ -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:
Expand Down
21 changes: 14 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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
```
Comment on lines +34 to +38
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix markdownlint issues.

The HomeBrew installation instructions are clear and correct. However, there are markdownlint issues to address:

  • Headings should be surrounded by blank lines (MD022).
  • Unordered list style should be consistent (MD004).
  • Fenced code blocks should be surrounded by blank lines (MD031).
  • Lists should be surrounded by blank lines (MD032).
## Installation

- using HomeBrew

+ 
```console
brew tap hckr-cli/tap
brew install hckr
  • using pip
pip install hckr

<details>
<summary>Tools</summary>

<details>
<summary>Markdownlint</summary><blockquote>

33-33: Expected: dash; Actual: asterisk
Unordered list style

(MD004, ul-style)

---

34-34: null
Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)

---

37-37: null
Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)

---

33-33: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

---

33-33: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

</blockquote></details>

</details>

<!-- This is an auto-generated comment by CodeRabbit -->

* using pip
```console
pateash marked this conversation as resolved.
Show resolved Hide resolved
pip install hckr
```

## License

`hckr` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
Expand Down
1 change: 1 addition & 0 deletions docs/source/_templates/components/nav-versions.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<!--this is to avoid showing version in navbar-->
1 change: 1 addition & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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=========================='"
Expand Down
Loading