Rename package from em_keyboard to em

.coveragerc

@@ -8,4 +8,4 @@ exclude_also =
 
 [run]
 omit =
-    **/em_keyboard/__main__.py
+    **/em/__main__.py

.pre-commit-config.yaml

@@ -23,7 +23,7 @@ repos:
       - id: check-yaml
       - id: debug-statements
       - id: end-of-file-fixer
-        exclude: ^src/em_keyboard/emojis.json$
+        exclude: ^src/em/emojis.json$
       - id: forbid-submodules
       - id: trailing-whitespace
 
@@ -63,7 +63,7 @@ repos:
     hooks:
       - id: prettier
         args: [--prose-wrap=always, --print-width=88]
-        exclude: ^src/em_keyboard/emoji.*\.json$
+        exclude: ^src/em/emoji.*\.json$
 
   - repo: meta
     hooks:

pyproject.toml

@@ -6,7 +6,7 @@ requires = [
 ]
 
 [project]
-name = "em-keyboard"
+name = "em"
 description = "The CLI Emoji Keyboard"
 readme = "README.md"
 keywords = [
@@ -46,17 +46,17 @@ optional-dependencies.tests = [
 urls.Changelog = "https://github.com/hugovk/em-keyboard/releases"
 urls.Homepage = "https://github.com/hugovk/em-keyboard"
 urls.Source = "https://github.com/hugovk/em-keyboard"
-scripts.em = "em_keyboard.cli:main"
+scripts.em = "em.cli:main"
 
 [tool.hatch]
 version.source = "vcs"
 
 [tool.hatch.build.hooks.vcs]
-version-file = "src/em_keyboard/_version.py"
+version-file = "src/em/_version.py"
 
 [tool.hatch.build.targets.sdist]
 exclude = [
-  "src/em_keyboard/emoji-en-US.json", # temporary copy of "src/em_keyboard/emojis.json"
+  "src/em/emoji-en-US.json", # temporary copy of "src/em/emojis.json"
 ]
 
 [tool.hatch.version.raw-options]
@@ -92,7 +92,7 @@ lint.ignore = [
 ]
 lint.flake8-import-conventions.aliases.datetime = "dt"
 lint.flake8-import-conventions.banned-from = [ "datetime" ]
-lint.isort.known-first-party = [ "em_keyboard" ]
+lint.isort.known-first-party = [ "em" ]
 lint.isort.required-imports = [ "from __future__ import annotations" ]
 
 [tool.pyproject-fmt]

scripts/despacify.py

@@ -6,10 +6,10 @@
 
 import json
 
-from em_keyboard import EmojiDict, clean_name, parse_emojis  # type: ignore[import]
+from em import EmojiDict, clean_name, parse_emojis  # type: ignore[import]
 
-INPUT_EMOJILIB_PATH = "src/em_keyboard/emoji-en-US.json"
-OUTPUT_EMOJI_PATH = "src/em_keyboard/emojis.json"
+INPUT_EMOJILIB_PATH = "src/em/emoji-en-US.json"
+OUTPUT_EMOJI_PATH = "src/em/emojis.json"
 
 
 def save_emojis(data: EmojiDict, filename: str) -> None:

scripts/update-emojilib.sh

@@ -1,5 +1,5 @@
 #!/usr/bin/env bash
 
-wget https://github.com/muan/emojilib/raw/main/dist/emoji-en-US.json -O src/em_keyboard/emoji-en-US.json
-echo >> src/em_keyboard/emoji-en-US.json  # Add newline to end of file
+wget https://github.com/muan/emojilib/raw/main/dist/emoji-en-US.json -O src/em/emoji-en-US.json
+echo >> src/em/emoji-en-US.json  # Add newline to end of file
 python3 scripts/despacify.py

src/em_keyboard/__init__.py → src/em/__init__.py

@@ -18,11 +18,11 @@
 import os
 from importlib.resources import as_file, files
 
-from em_keyboard import _version
+from em import _version
 
 __version__ = _version.__version__
 
-with as_file(files("em_keyboard").joinpath("emojis.json")) as em_json:
+with as_file(files("em").joinpath("emojis.json")) as em_json:
     EMOJI_PATH = em_json
 
 CUSTOM_EMOJI_PATH = os.path.join(os.path.expanduser("~/.emojis.json"))

src/em_keyboard/__main__.py → src/em/__main__.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from em_keyboard import cli
+from em import cli
 
 if __name__ == "__main__":
     cli.main()

src/em_keyboard/cli.py → src/em/cli.py

@@ -1,5 +1,5 @@
 """
-CLI for em_keyboard
+CLI for em
 """
 
 from __future__ import annotations
@@ -8,7 +8,7 @@
 import os
 import sys
 
-from em_keyboard import (
+from em import (
     CUSTOM_EMOJI_PATH,
     __version__,
     clean_name,

tests/test_em.py

@@ -6,7 +6,7 @@
 
 import pytest
 
-from em_keyboard import cli, try_copy_to_clipboard  # type: ignore[import-untyped]
+from em import cli, try_copy_to_clipboard  # type: ignore[import-untyped]
 
 copier_deps_installed = try_copy_to_clipboard("checking if copy works")
 
@@ -20,7 +20,7 @@
         ":Star:",
     ],
 )
-@patch("em_keyboard.cli.argparse.ArgumentParser.parse_args")
+@patch("em.cli.argparse.ArgumentParser.parse_args")
 @patch("builtins.print")
 def test_star(mock_print: MagicMock, mock_argparse: MagicMock, test_name: str) -> None:
     # Arrange
@@ -41,7 +41,7 @@ def test_star(mock_print: MagicMock, mock_argparse: MagicMock, test_name: str) -
     assert e.value.code == 0
 
 
-@patch("em_keyboard.cli.argparse.ArgumentParser.parse_args")
+@patch("em.cli.argparse.ArgumentParser.parse_args")
 @patch("builtins.print")
 def test_not_found(mock_print: MagicMock, mock_argparse: MagicMock) -> None:
     # Arrange
@@ -58,7 +58,7 @@ def test_not_found(mock_print: MagicMock, mock_argparse: MagicMock) -> None:
     assert e.value.code == 1
 
 
-@patch("em_keyboard.cli.argparse.ArgumentParser.parse_args")
+@patch("em.cli.argparse.ArgumentParser.parse_args")
 @patch("builtins.print")
 def test_no_copy(mock_print: MagicMock, mock_argparse: MagicMock) -> None:
     # Arrange
@@ -76,7 +76,7 @@ def test_no_copy(mock_print: MagicMock, mock_argparse: MagicMock) -> None:
     assert e.value.code == 0
 
 
-@patch("em_keyboard.cli.argparse.ArgumentParser.parse_args")
+@patch("em.cli.argparse.ArgumentParser.parse_args")
 @patch("builtins.print")
 def test_search_star(mock_print: MagicMock, mock_argparse: MagicMock) -> None:
     # Arrange
@@ -100,7 +100,7 @@ def test_search_star(mock_print: MagicMock, mock_argparse: MagicMock) -> None:
     assert e.value.code == 0
 
 
-@patch("em_keyboard.cli.argparse.ArgumentParser.parse_args")
+@patch("em.cli.argparse.ArgumentParser.parse_args")
 @patch("builtins.print")
 def test_search_single_result_is_copied(
     mock_print: MagicMock, mock_argparse: MagicMock
@@ -123,7 +123,7 @@ def test_search_single_result_is_copied(
     assert e.value.code == 0
 
 
-@patch("em_keyboard.cli.argparse.ArgumentParser.parse_args")
+@patch("em.cli.argparse.ArgumentParser.parse_args")
 @patch("builtins.print")
 def test_search_not_found(mock_print: MagicMock, mock_argparse: MagicMock) -> None:
     # Arrange
@@ -141,7 +141,7 @@ def test_search_not_found(mock_print: MagicMock, mock_argparse: MagicMock) -> No
     assert e.value.code == 1
 
 
-@patch("em_keyboard.cli.argparse.ArgumentParser.parse_args")
+@patch("em.cli.argparse.ArgumentParser.parse_args")
 @patch("builtins.print")
 def test_search_multi_word(mock_print: MagicMock, mock_argparse: MagicMock) -> None:
     # Arrange
@@ -162,7 +162,7 @@ def test_search_multi_word(mock_print: MagicMock, mock_argparse: MagicMock) -> N
     assert e.value.code == 0
 
 
-@patch("em_keyboard.cli.argparse.ArgumentParser.parse_args")
+@patch("em.cli.argparse.ArgumentParser.parse_args")
 @patch("builtins.print")
 def test_random(mock_print: MagicMock, mock_argparse: MagicMock) -> None:
     # Arrange
@@ -184,7 +184,7 @@ def test_random(mock_print: MagicMock, mock_argparse: MagicMock) -> None:
     assert e.value.code == 0
 
 
-@patch("em_keyboard.cli.argparse.ArgumentParser.parse_args")
+@patch("em.cli.argparse.ArgumentParser.parse_args")
 @patch("builtins.print")
 def test_random_no_copy(mock_print: MagicMock, mock_argparse: MagicMock) -> None:
     # Arrange
@@ -203,7 +203,7 @@ def test_random_no_copy(mock_print: MagicMock, mock_argparse: MagicMock) -> None
     assert e.value.code == 0
 
 
-@patch("em_keyboard.cli.argparse.ArgumentParser.parse_args")
+@patch("em.cli.argparse.ArgumentParser.parse_args")
 @patch("builtins.print")
 def test_no_name(mock_print: MagicMock, mock_argparse: MagicMock) -> None:
     # Arrange

tox.ini

@@ -11,7 +11,7 @@ extras =
     tests
 commands =
     {envpython} -m pytest \
-      --cov em_keyboard \
+      --cov em \
       --cov tests \
       --cov-report html \
       --cov-report term \