add github workflow (#1)

* add github workflow

* fix typo

* add more docs

.github/workflows/ci.yml

@@ -0,0 +1,32 @@
+name: ci
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    name: Running python ${{ matrix.python-version }} on ${{matrix.os}}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: ["3.7", "3.8", "3.9", "3.10"]
+        os: [ubuntu-latest, macos-latest, windows-latest]
+      fail-fast: false
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install pip and dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install pytest
+    - name: Install killport
+      run: |
+        pip install .
+    - name: Run tests
+      run: |
+        pytest .

README.md

@@ -4,7 +4,7 @@ Kill processes using a given port on your laptop.
 
 ## Installation
 
-`pip install keyport`
+`pip install killport`
 
 ## Usage
 
@@ -16,3 +16,8 @@ Kill processes using a given port on your laptop.
 
 `killport 1234 --view-only`
 - Displays the processes that would be deleted, but doesn't actually delete them.
+
+## How does this differ from...
+
+- [freeport](https://github.com/yashbathia/freeport/) -- Windows support, since this uses `psutil` rather than `lsof`
+- [kill-port](https://github.com/tiaanduplessis/kill-port) -- Very similar, but this is available in PyPI vs NPM

killport.py

@@ -37,7 +37,6 @@ def kill_ports(*, ports: list[int], view_only: bool = False) -> int:
         process = pinfo.process
         print(f'- {process.name()} (pid {process.pid}) on port {pinfo.port}')
         if not view_only:
-            print(f'sending sigterm to {pinfo}')
             process.send_signal(SIGTERM)
 
     return 1 if processes else 0