Skip to content

Commit 6c099ff

Browse files
committed
updated package name and doc colors
1 parent aa55a9d commit 6c099ff

File tree

5 files changed

+15
-18
lines changed

5 files changed

+15
-18
lines changed

Makefile

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,16 @@
88
.DEFAULT_GOAL := help
99
default: help
1010

11-
COLOR_RESET=\033[0m
12-
COLOR_CYAN_BOLD=\033[1;36m
1311
define INFO_MESSAGE
14-
@echo "⏩$(COLOR_CYAN_BOLD)$(1)$(COLOR_RESET)"
12+
@echo "⏩\033[1;38;5;208m$(1)\033[0m"
1513
endef
1614

1715
############################################################################
1816
#= BASIC USAGE
1917

2018
.PHONY: help
2119
help: ## Display help message
20+
$(call INFO_MESSAGE, Prepare local dev env: Create virtual env and install the pre-commit hooks)
2221
@./sbin/makefile-extract-documentation ${MAKEFILE_LIST}
2322

2423
############################################################################
@@ -27,10 +26,10 @@ help: ## Display help message
2726
install: devready
2827
.PHONY: devready
2928
devready: ## Prepare local dev env: Create virtual env, install the pre-commit hooks
30-
$(call INFO_MESSAGE, "Prepare local dev env: Create virtual env and install the pre-commit hooks")
29+
$(call INFO_MESSAGE, Prepare local dev env: Create virtual env and install the pre-commit hooks)
3130
uv sync --dev
3231
uv run pre-commit install
33-
@echo '⚠️ Activate the virtual env with `source .venv/bin/activate`'
32+
$(call INFO_MESSAGE, Activate the virtual env with \`source .venv/bin/activate\`)
3433

3534
.PHONY: build
3635
build: ## Build package

TODO

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,6 @@
1414
- uv build
1515
- uv publish
1616

17-
uvx --from biocommons-example marvin-quote
17+
uvx --from python-package marvin-quote
1818

1919
- [ ] move installation instructions to docs

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ keywords = [
5151
"variation"
5252
]
5353
license = "Apache-2.0"
54-
name = "biocommons-example"
54+
name = "python-package"
5555
readme = "README.md"
5656
requires-python = ">=3.11"
5757

sbin/makefile-extract-documentation

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,25 +12,23 @@ import re
1212

1313
CSI = "\033["
1414
BOLD = CSI + "1m"
15-
COMMAND_COLOR = CSI + "36m"
16-
HEADER_COLOR = CSI + "32m"
17-
RESET = CSI + "0m"
18-
SECTION_COLOR = CSI + "95m"
1915
UNDERLINE = CSI + "4m"
16+
RESET = CSI + "0m"
17+
HEADER_COLOR = CSI + "38;5;208m"
18+
SECTION_COLOR = "" # CSI + "38;5;99m"
19+
COMMAND_COLOR = CSI + "38;5;208m"
2020

21-
print(f"""🌟🌟 {BOLD}{HEADER_COLOR}{UNDERLINE}MAKE TARGETS{RESET} 🌟🌟
22-
23-
usage: make [target ...]
21+
print("""usage: make [target ...]
2422
2523
biocommons packages consolidate command invocations in make targets to promote
26-
consistency across developers and environments (including GitHub actions). Using
27-
other invocations is not supported and will be ignored in bug reports.
24+
consistency across developers and environments, including GitHub actions. Using
25+
other invocation methods is not supported and will be ignored in bug reports.
2826
2927
This makefile supports the following targets:
3028
""")
3129

3230
for line in fileinput.input(): # noqa: SIM115
3331
if m := re.match(r"#= (.+)", line):
34-
print(f"\n{BOLD}{UNDERLINE}{SECTION_COLOR}{m.group(1)}{RESET}")
32+
print(f"\n{UNDERLINE}{SECTION_COLOR}{m.group(1)}{RESET}")
3533
elif m := re.match(r"([-\s\w]+):.+?##\s+(.+)", line):
3634
print(f"{BOLD}{COMMAND_COLOR}{m.group(1):<20}{RESET}{m.group(2)}")

uv.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)