tidy up the command mess

Author: honzajavorek

.github/workflows/main.yml

@@ -19,15 +19,15 @@ jobs:
       run: uv sync
     - if: ${{ github.ref == 'refs/heads/master' }}
       name: Build data
-      run: uv run python -m pyvecorg.build
+      run: make build
       env:
         GOOGLE_SERVICE_ACCOUNT: ${{ secrets.GOOGLE_SERVICE_ACCOUNT }}
     - name: Run tests
-      run: uv run pytest -v
+      run: make test
     - name: Build HTML
-      run: uv run python -m pyvecorg freeze
+      run: make freeze
     - if: ${{ github.ref == 'refs/heads/master' }}
       name: Deploy
-      run: uv run python -m pyvecorg deploy
+      run: make deploy
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Makefile

@@ -0,0 +1,16 @@
+.PHONY: serve freeze deploy build test
+
+serve:
+	uv run python -m pyvecorg serve
+
+freeze:
+	uv run python -m pyvecorg freeze
+
+deploy:
+	uv run python -m pyvecorg deploy --push
+
+build:
+	uv run python -m pyvecorg.build
+
+test:
+	uv run pytest -v

README.md

@@ -15,9 +15,9 @@ $ uv sync
 The site uses [elsa](https://github.com/pyvec/elsa).
 
 - Installation: `uv sync`
-- Download data from external sources: `uv run python -m pyvecorg.build`
-- Tests: `uv run pytest`
-- Development server: `uv run python -m pyvecorg serve`
+- Download data from external sources: `make build`
+- Tests: `make test`
+- Development server: `make serve`
 
 ### Data and tests
 
@@ -39,15 +39,15 @@ logical rules which cannot be easily expressed by JSON Schema.
 ### External sources
 
 Some data cannot be stored statically in a YAML file. There is a command
-`uv run python -m pyvecorg.build`, which downloads them from external sources and generates
+`make build`, which downloads them from external sources and generates
 respective static YAML files. This is a separate step, which needs to be done
 before developing or deploying the site, otherwise it won't work properly.
 
 ### Members
 
 Pyvec members are tracked in an internal Google Spreadsheet. The future
 intention is to have the list of members public, but we're not there yet (GDPR).
-So far only board members are being listed publicly. The `uv run python -m pyvecorg.build`
+So far only board members are being listed publicly. The `make build`
 command downloads the spreadsheet as CSV and generates the `members_list.yml`
 file. It also downloads and caches avatars.
 

src/pyvecorg/build.py

@@ -65,8 +65,7 @@ def generate_yaml(data):
     yaml_contents = dedent('''\
         #
         #  This file has been generated from external sources
-        #  using `uv run python -m pyvecorg.build`. Do not edit
-        #  it manually!
+        #  using `make build`. Do not edit it manually!
         #
     ''')
     return yaml_contents + yaml.dump(data, allow_unicode=True)

src/pyvecorg/templates/index.html

@@ -269,7 +269,7 @@ <h3>{{ members.note.heading }}</h3>
             {% else %}
                 <p class="note">
                     {{ members.list.failure_text }}
-                    <!-- To fix this, you need to run 'uv run python -m pyvecorg.build' -->
+                    <!-- To fix this, you need to run 'make build' -->
                 </p>
             {% endif %}
         </div>

tests/test_data.py

@@ -20,9 +20,9 @@
 )
 DATA = load_data()
 
-# If you run 'uv run python -m pyvecorg.build', memebers_list.yml
-# gets generated and it will be tested. If you don't have the file
-# present, the relevant tests will be skipped
+# If you run 'make build', memebers_list.yml gets generated and it
+# will be tested. If you don't have the file present, the relevant
+# tests will be skipped
 DATA_BOARD = DATA.get('members_list', {}).get('board', [])
 DATA_PUBLIC_MEMBERS = DATA.get('members_list', {}).get('public_members', [])
 DATA_ALL_MEMBERS = DATA_BOARD + DATA_PUBLIC_MEMBERS