commonknowledge / groundwork Goto Github PK

Notes from the pairing session, where we managed to overcome the VSCode devcontainer set up and missing dependencies.

sudo chown -R $(whoami) .
make bootstrap
curl https://raw.githubusercontent.com/commonknowledge/do-app-baseimage-django-node/439e8fecc8279266fcdd80942640000a1fb5a3ba/.bin/prepare.sh | /bin/bash

As noted in wagtail/wagtail#7689 (reply in thread), this library doesn't have JS tests yet.

• Add templatetag
• Example of how to use it (e.g. clustering via superclusterd)

We provide the ability to customize our mapbox widgets with custom themes and styles, but actually using this requires people to use the relatively low-level mapbox style DSL.

Add some python helpers to produce the mapbox json for common requirements, such as:

• Showing markers for datapoints within the current view.
• Rendering some html into a popover for a given datapoint (possibly by fetching html over the wire).
• Shading a geographical area with a data-driven color. Support user interactions on painted areas.
• Rendering points onto the map via geojson. Support clustering and fetch-on-demand.

Have built this out here: https://github.com/commonknowledge/leftbookclub/blob/cc62ea20a74cec9cc0a769f0e1393360121e9db2/app/models/circle.py

• Add to contrib
• Add example code / explainer to docs
• Let Circle.so team know so they can mention it too!

There's already one for Data Pipelining.

• Simple: explain the primitives + how how they fit together
• Complex: how to extend them (e.g. Stimulus controllers, alternative templatetag implementations)
• Real code examples that pique your curiosity, showing how Stimulus controllers + Django views and templates come together to make something visually interesting:
  • https://github.com/commonknowledge/leftbookclub/blob/main/app/templates/app/includes/event_list_and_map.html

Obviously this can be done via CLI, but it would be nice if this were also available for free via the Django Admin or somesuch.

Parsons provides an extensive suite of connectors for common tools used by progressive organisations, with a Table abstraction that isn't a million miles away from our Datasource (for list queries, at least).

Investigate a way of allowing Parsons connectors to be used easily in this library.

This might take the form of a Datasource subclass with an abstract method that subclassers implement to return a Parsons table, for example.

In the docs, edit links point to commonknowledge/groundwork. We should probably change this repository's name.

Resolved with override:

    def get_serializer_field_kwargs(self, field):
        type_info = get_type_info(field.type)

        if type_info.base_type == str and not type_info.is_many and not type_info.is_mapping:
            return {"allow_blank": True}

        if type_info.is_mapping or type_info.is_many:
            return {"allow_empty": True}

        return {}

AIrtable is a popular tool used by organisers for ad-hoc data capture and management.

Add a Datasource subclass that is able to connect to Airtable bases and map them into Python dataclasses.

@janbaykara suggests:

Occurred to me that there could be scope for including a django variant of Ruby-style import maps, for loading Stimulus controller files for templates, as an alternative to bundling them altogether.

We in fact kind of already have this behaviour by using dynamic import() via vite's import.meta.glob to load and register controllers on-demand.

Using import maps could prove to be a more 'standard' way of providing this behaviour. Especially when the django hotwired libraries mature a bit.

Release workflow is failing: https://github.com/commonknowledge/groundwork/actions/runs/2097768625

Unsure why this is, as release 0.1.2 used the same workflow and the db service hasn't been changed either v0.1.2...v0.1.3

db service starts

   docker.io/kartoza/postgis:latest
  /usr/bin/docker create --name 209d5af565794f609c0ae5cd4061e8db_kartozapostgislatest_c836e0 --label 2bcf09 --network github_network_5b496bb6f92648099e3cf3b47c911a79 --network-alias db  -e "POSTGRES_USER=postgres" -e "POSTGRES_PASSWORD=postgres" -e "POSTGRES_DBNAME=postgres" -e "POSTGRES_HOSTNAME=postgres" -e "POSTGRES_PORT=5432" -e GITHUB_ACTIONS=true -e CI=true kartoza/postgis:latest
  22e58ab40abb3a86e8014dde579ffd41ce2372d0ae0940705cde3a54d9331bde
  /usr/bin/docker start 22e58ab40abb3a86e8014dde579ffd41ce2372d0ae0940705cde3a54d9331bde
  22e58ab40abb3a86e8014dde579ffd41ce2372d0ae0940705cde3a54d9331bde
  /usr/bin/docker ps --all --filter id=22e58ab40abb3a86e8014dde579ffd41ce2372d0ae0940705cde3a54d9331bde --filter status=running --no-trunc --format "{{.ID}} {{.Status}}"
  22e58ab40abb3a86e8014dde579ffd41ce2372d0ae0940705cde3a54d9331bde Up Less than a second

wait-for-it fails

Run .github/bin/wait-for-it.sh db:5432
  .github/bin/wait-for-it.sh db:5432
  shell: sh -e {0}
/__w/_temp/c4db5d80-dd3d-4c30-a5b4-b0517bd4279e.sh: 1: /__w/_temp/c4db5d80-dd3d-4c30-a5b4-b0517bd4279e.sh: .github/bin/wait-for-it.sh: Permission denied
Error: Process completed with exit code 126.

Container logs

2022-04-05 17:36:00.133 UTC [72] LOG:  database system is ready to accept connections

Re: @janbaykara's comment:

One comment on the docs: could we find a way in https://groundwork.commonknowledge.coop/api/pyck.geo.territories.uk.parliament/ to have the list of actual resources (constituencies, members, parties) at the top of the page, rather than the bottom beneath the internals? Usage starts by pulling one of those into the the datasource argument, after all, so nice to have the menu options up front.

Re @conatus ' comment on SyncedModel:

One question I do have is what does one do when one doesn't want to sync the data periodically with a Cron. The documentation doesn't answer this directly. We can imagine some cases where the data changes quite rapidly and is important to keep up to date. I presume we somehow override the method, but can't be sure. I don't think this blocks this very good work going in however! Maybe take a ticket to document this situation?

Looks like the latest deployments are failing, so API docs aren't up.