Merge pull request #18 from erlete:package-rename

Rename package
erlete · Jan 20, 2024 · 73b7ee1 · 73b7ee1
2 parents 0a4ad1b + 9d06050
commit 73b7ee1
Show file tree

Hide file tree

Showing 12 changed files with 11 additions and 9 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -12,6 +12,7 @@ A clear and concise description of what the bug is.
 
 **To Reproduce**
 Steps to reproduce the behavior:
+
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
@@ -24,10 +25,11 @@ A clear and concise description of what you expected to happen.
 If applicable, add screenshots to help explain your problem.
 
 **Environment (please complete the following information):**
- - OS: [e.g. Windows 10]
- - Python setup: [e.g. Python 3.10]
- - Package manager [e.g. `pip`]
- - Package version [e.g. `coordinate-canvas==1.4.1`]
+
+- OS: [e.g. Windows 10]
+- Python setup: [e.g. Python 3.10]
+- Package manager [e.g. `pip`]
+- Package version [e.g. `ccanvas==1.4.1`]
 
 **Additional context**
 Add any other context about the problem here.
diff --git a/.github/workflows/python-tests.yml b/.github/workflows/python-tests.yml
@@ -50,7 +50,7 @@ jobs:
       run: python -m pip install .[test]
 
     - name: Test with PyTest
-      run: python -m pytest --color=yes --capture=no --cov-config=.coveragerc --cov-report=lcov --cov=src/coordinate_canvas
+      run: python -m pytest --color=yes --capture=no --cov-config=.coveragerc --cov-report=lcov --cov=src/ccanvas
 
     - name: Upload coverage file artifact
       uses: actions/upload-artifact@v3

diff --git a/README.md b/README.md
@@ -8,15 +8,15 @@ Interactive canvas that allows you to draw 2D coordinates in a plane and output
 ## Installation
 
 ```bash
-python -m pip install coordinate-canvas  # Use dash instead of underscore!
+python -m pip install ccanvas  # Use dash instead of underscore!
 ```
 
 ## Usage
 
 You can display the help message by running the following command:
 
 ```bash
-python -m coordinate_canvas --help  # Use underscore instead of dash!
+python -m ccanvas --help  # Use underscore instead of dash!
 ```
 
 Once the canvas has been opened, you will be able to click on any part of it and add a new coordinate. Lines can be switched using the numeric pad on the keyboard, as explained on the header of the window.

diff --git a/pyproject.toml b/pyproject.toml
@@ -3,7 +3,7 @@ requires = ["setuptools"]
 build-backend = "setuptools.build_meta"
 
 [project]
-name = "coordinate-canvas"
+name = "ccanvas"
 version = "1.5.1"
 description = "Matplotlib-based canvas that allows line drawing and coordinate retrieval"
 readme = "README.md"

diff --git a/src/coordinate_canvas/__init__.py → src/ccanvas/__init__.py b/src/coordinate_canvas/__init__.py → src/ccanvas/__init__.py
diff --git a/src/coordinate_canvas/__main__.py → src/ccanvas/__main__.py b/src/coordinate_canvas/__main__.py → src/ccanvas/__main__.py
diff --git a/src/coordinate_canvas/config.py → src/ccanvas/config.py b/src/coordinate_canvas/config.py → src/ccanvas/config.py
diff --git a/src/coordinate_canvas/core/__init__.py → src/ccanvas/core/__init__.py b/src/coordinate_canvas/core/__init__.py → src/ccanvas/core/__init__.py
diff --git a/src/coordinate_canvas/core/canvas.py → src/ccanvas/core/canvas.py b/src/coordinate_canvas/core/canvas.py → src/ccanvas/core/canvas.py
diff --git a/src/coordinate_canvas/core/line_builder.py → src/ccanvas/core/line_builder.py b/src/coordinate_canvas/core/line_builder.py → src/ccanvas/core/line_builder.py
diff --git a/src/coordinate_canvas/interface/__init__.py → src/ccanvas/interface/__init__.py b/src/coordinate_canvas/interface/__init__.py → src/ccanvas/interface/__init__.py
diff --git a/src/coordinate_canvas/interface/cli.py → src/ccanvas/interface/cli.py b/src/coordinate_canvas/interface/cli.py → src/ccanvas/interface/cli.py
@@ -11,7 +11,7 @@
 from ..core.canvas import Canvas
 
 
-@click.command("coordinate-canvas")
+@click.command("ccanvas")
 @click.option(
     "--width",
     "-w",