refactor: rename project/api to "purple" (#252)

* refactor: rpctracker -> purple API name

* refactor: rpctracker purple module

* ci: rename rpc-purple to purple for images

* ci: rename rpc-app-base to purple-app-base

Author: jennifer-richards

.github/workflows/build-base-app.yml

@@ -39,4 +39,4 @@ jobs:
         file: docker/base.Dockerfile
         platforms: linux/amd64,linux/arm64
         push: true
-        tags: ghcr.io/ietf-tools/rpc-app-base:latest
+        tags: ghcr.io/ietf-tools/purple-app-base:latest

.github/workflows/build.yml

@@ -37,25 +37,25 @@ jobs:
           file: dev/build/backend.Dockerfile
           platforms: linux/amd64
           push: true
-          tags: ghcr.io/ietf-tools/rpc-purple-backend:latest
+          tags: ghcr.io/ietf-tools/purple-backend:latest
 
       - name: Generate Purple API client
         run: |
-          container_id="$(docker create ghcr.io/ietf-tools/rpc-purple-backend:latest)"
-          docker cp "${container_id}:/workspace/purple-api.yaml" ./
+          container_id="$(docker create ghcr.io/ietf-tools/purple-backend:latest)"
+          docker cp "${container_id}:/workspace/purple_api.yaml" ./
           docker rm "${container_id}"
           npx --yes @openapitools/openapi-generator-cli generate --generator-key purple
-          tar cfz rpctracker_client.tgz -C client rpctracker_client
+          tar cfz purple_client.tgz -C client purple_client
 
       - name: Upload API
         uses: actions/upload-artifact@v4
         with:
           name: api-clients
           path: |
-            purple-api.yaml
+            purple_api.yaml
             rpcapi.yaml
+            purple_client.tgz
             rpcapi_client.tgz
-            rpctracker_client.tgz
 
       - name: Build frontend image
         uses: docker/build-push-action@v6
@@ -67,4 +67,4 @@ jobs:
           file: dev/build/frontend.Dockerfile
           platforms: linux/amd64
           push: true
-          tags: ghcr.io/ietf-tools/rpc-purple-frontend:latest
+          tags: ghcr.io/ietf-tools/purple-frontend:latest

README.md

@@ -93,9 +93,9 @@ and all data in the RPC tool's database will be reset. The Datatracker _will not
 
 This project uses two distinct HTTP APIs. Both are accessed using clients generated from OpenAPI specifications. The clients are generated using [OpenAPI Generator](https://openapi-generator.tech/).
 
-### Front-end to Back-end: `rpctracker_api`
+### Front-end to Back-end: `purple_api`
 
-This API is used by the Nuxt Client front end to communicate with the Django back end. This API is defined by this project through an OpenAPI specification in `rpctracker_api.json`. The API is implemented using the `django-rest-framework` and the spec is generated using `drf-spectacular`.
+This API is used by the Nuxt Client front end to communicate with the Django back end. This API is defined by this project through an OpenAPI specification in `purple_api.json`. The API is implemented using the `django-rest-framework` and the spec is generated using `drf-spectacular`.
 
 ### Back-end to Datatracker: `rpcapi`
 
@@ -107,7 +107,7 @@ If changes are made to the APIs, you will need to update the clients. If this in
 ```sh
 ./update-rpcapi
 ```
-This uses [OpenAPI Generator](https://openapi-generator.tech/) to regenerate `rpctracker_api.json` and builds both the API clients. It may take a minute or two. When it is done, restart the Django dev server. The Nuxt server normally picks up the changes automatically.
+This uses [OpenAPI Generator](https://openapi-generator.tech/) to regenerate `purple_api.json` and builds both the API clients. It may take a minute or two. When it is done, restart the Django dev server. The Nuxt server normally picks up the changes automatically.
 
 ## Cleanup
 

client/components/AssignmentsTypes.ts

@@ -1,4 +1,4 @@
-import type { Assignment, RfcToBe, RpcPerson, RpcRole } from '~/rpctracker_client'
+import type { Assignment, RfcToBe, RpcPerson, RpcRole } from '~/purple_client'
 
 export type ResolvedAssignment = Omit<Assignment, 'person'> & {
   person?: RpcPerson

client/components/BaseBadge.vue

@@ -11,7 +11,7 @@
 </template>
 
 <script setup lang="ts">
-import type { ColorEnum } from '~/rpctracker_client'
+import type { ColorEnum } from '~/purple_client'
 
 type Props = {
   /**

client/components/DocComplexityCard.vue

@@ -15,7 +15,7 @@
 
 <script setup lang="ts">
 
-import type { Capability } from '~/rpctracker_client'
+import type { Capability } from '~/purple_client'
 
 type Props = {
   capabilities: Capability[]

client/components/DocExceptionsCard.vue

@@ -14,7 +14,7 @@
 </template>
 
 <script setup lang="ts">
-import type { Label } from '~/rpctracker_client'
+import type { Label } from '~/purple_client'
 
 type Props = { labels: Label[] }
 

client/components/DocInfoCard.vue

@@ -57,7 +57,7 @@
 </template>
 
 <script setup lang="ts">
-import type { RfcToBe } from '~/rpctracker_client'
+import type { RfcToBe } from '~/purple_client'
 
 type Props = {
   draft: (Record<PropertyKey, unknown> & RfcToBe) | null

client/components/DocumentTable.vue

@@ -70,7 +70,7 @@
 import { RpcLabel, Icon, NuxtLink } from '#components'
 import { isArray, isFunction, orderBy } from 'lodash-es'
 import type { Column, Row } from './DocumentTableTypes'
-import type { ColorEnum, Label } from '~/rpctracker_client'
+import type { ColorEnum, Label } from '~/purple_client'
 
 const props = defineProps<{
   /**

client/components/DocumentTableTypes.ts

@@ -1,5 +1,5 @@
 import type { VNode } from 'vue'
-import type { ColorEnum } from '~/rpctracker_client'
+import type { ColorEnum } from '~/purple_client'
 
 export type Value = unknown
 

client/components/RpcLabel.vue

@@ -6,7 +6,7 @@
 </template>
 
 <script setup lang="ts">
-import type { Label } from '~/rpctracker_client'
+import type { Label } from '~/purple_client'
 
 type Props = {
   label?: Label

client/components/RpcLabelEditDialog.vue

@@ -72,8 +72,8 @@
 </template>
 
 <script setup lang="ts">
-import { ColorEnum } from '~/rpctracker_client'
-import type { Label } from '~/rpctracker_client'
+import { ColorEnum } from '~/purple_client'
+import type { Label } from '~/purple_client'
 import { overlayModalMethodsKey } from '../providers/providerKeys'
 
 const api = useApi()

client/components/RpcLabelPicker.vue

@@ -41,7 +41,7 @@
 </template>
 
 <script setup lang="ts">
-import type { Label } from '~/rpctracker_client'
+import type { Label } from '~/purple_client'
 
 // work around hydration mismatch bug in Headless by explicitly generating stable IDs
 const comboboxLabelId = useId()

client/composables/useApi.ts

@@ -1,4 +1,4 @@
-import { Configuration, RpcTrackerApi } from '~/rpctracker_client'
+import { Configuration, PurpleApi } from '~/purple_client'
 
 const safeMethods = ['GET', 'HEAD', 'OPTIONS', 'TRACE']
 
@@ -26,5 +26,5 @@ export const useApi = () => {
       }
     }]
   })
-  return new RpcTrackerApi(configuration)
+  return new PurpleApi(configuration)
 }

client/eslint.config.mjs

@@ -44,7 +44,7 @@ export default withNuxt(
     ignores: [
       '.nuxt/',
       '.output/',
-      'rpctracker_client/'
+      'purple_client/'
     ]
   }
 )

client/pages/docs/[id]/enqueue.vue

@@ -44,7 +44,7 @@
 
 <script setup lang="ts">
 
-import type { Capability, Label, RfcToBe } from '~/rpctracker_client'
+import type { Capability, Label, RfcToBe } from '~/purple_client'
 import type { Column } from '~/components/DocumentTableTypes'
 
 const route = useRoute()

client/pages/docs/assignments.vue

@@ -68,7 +68,7 @@
 
 <script setup lang="ts">
 import type { ResolvedDocument, ResolvedPerson } from '~/components/AssignmentsTypes'
-import type { Assignment, RfcToBe, RpcPerson, RpcRole } from '~/rpctracker_client'
+import type { Assignment, RfcToBe, RpcPerson, RpcRole } from '~/purple_client'
 import { DateTime } from 'luxon'
 
 const csrf = useCookie('csrftoken', { sameSite: 'strict' })

client/pages/docs/import.vue

@@ -136,7 +136,7 @@
 <script setup lang="ts">
 import { DateTime } from 'luxon'
 import humanizeDuration from 'humanize-duration'
-import type { SourceFormatName, StdLevelName, StreamName, TlpBoilerplateChoiceName } from '~/rpctracker_client'
+import type { SourceFormatName, StdLevelName, StreamName, TlpBoilerplateChoiceName } from '~/purple_client'
 
 const route = useRoute()
 const api = useApi()

client/pages/labels/index.vue

@@ -40,7 +40,7 @@
 <script setup lang="ts">
 import { RpcLabelEditDialog } from '#components'
 import { overlayModalKey } from '~/providers/providerKeys'
-import type { Label } from '~/rpctracker_client'
+import type { Label } from '~/purple_client'
 
 const api = useApi()
 const snackbar = useSnackbar()

client/pages/queue/[section].vue

@@ -54,7 +54,7 @@ import { groupBy } from 'lodash-es'
 import { useSiteStore } from '@/stores/site'
 import Badge from '../../components/BaseBadge.vue'
 import type { Column, Row } from '~/components/DocumentTableTypes'
-import type { Assignment } from '~/rpctracker_client'
+import type { Assignment } from '~/purple_client'
 import type { Tab } from '~/components/TabNavTypes'
 
 // ROUTING

client/pages/stats.vue

@@ -32,7 +32,7 @@
 
 import { Duration } from 'luxon'
 import humanizeDuration from 'humanize-duration'
-import type { LabelStats } from '../rpctracker_client'
+import type { LabelStats } from '../purple_client'
 
 const api = useApi()
 

client/pages/team/index.vue

@@ -64,7 +64,7 @@
 <script setup lang="ts">
 import { UserCreateDialog } from '#components'
 import { overlayModalKey } from '~/providers/providerKeys'
-import type { RpcPerson } from '~/rpctracker_client'
+import type { RpcPerson } from '~/purple_client'
 
 const snackbar = useSnackbar()
 const _overlayModal = inject(overlayModalKey)

docker/app.Dockerfile

@@ -1,4 +1,4 @@
-FROM ghcr.io/ietf-tools/rpc-app-base:latest
+FROM ghcr.io/ietf-tools/purple-app-base:latest
 LABEL maintainer="IETF Tools Team <tools-discuss@ietf.org>"
 
 ENV DEBIAN_FRONTEND=noninteractive

manage.py

@@ -6,7 +6,7 @@
 
 def main():
     """Run administrative tasks."""
-    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "rpctracker.settings")
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "purple.settings")
     try:
         from django.core.management import execute_from_command_line
     except ImportError as exc:

openapitools.json

@@ -13,12 +13,12 @@
           "disallowAdditionalPropertiesIfNotPresent": false
         }
       },
-      "rpctracker": {
+      "purple": {
         "generatorName": "typescript-fetch",
-        "inputSpec": "#{cwd}/rpctracker_api.yaml",
-        "output": "#{cwd}/client/rpctracker_client",
+        "inputSpec": "#{cwd}/purple_api.yaml",
+        "output": "#{cwd}/client/purple_client",
         "additionalProperties": {
-          "packageName": "rpctracker_client",
+          "packageName": "purple_client",
           "disallowAdditionalPropertiesIfNotPresent": false
         }
       }

rpctracker/__init__.py purple/__init__.py

@@ -5,4 +5,4 @@ class RpcAutoSchema(AutoSchema):
     # pass
     def get_tags(self):
         # Override the default so that we get a single API tag
-        return ["rpc_tracker"]
+        return ["purple"]

rpctracker/openapi.py purple/openapi.py

@@ -60,7 +60,7 @@
     "simple_history.middleware.HistoryRequestMiddleware",
 ]
 
-ROOT_URLCONF = "rpctracker.urls"
+ROOT_URLCONF = "purple.urls"
 
 TEMPLATES = [
     {
@@ -78,7 +78,7 @@
     },
 ]
 
-WSGI_APPLICATION = "rpctracker.wsgi.application"
+WSGI_APPLICATION = "purple.wsgi.application"
 
 
 # Database
@@ -138,13 +138,13 @@
     "DEFAULT_PARSER_CLASSES": [
         "rest_framework.parsers.JSONParser",
     ],
-    "DEFAULT_SCHEMA_CLASS": "rpctracker.openapi.RpcAutoSchema",
+    "DEFAULT_SCHEMA_CLASS": "purple.openapi.RpcAutoSchema",
 }
 
 # DRF OpenApi schema settings
 SPECTACULAR_SETTINGS = {
-    "TITLE": "RpcTracker",
-    "DESCRIPTION": "Backend API for the RpcTracker",
+    "TITLE": "Purple",
+    "DESCRIPTION": "Backend API for the Purple app",
     "VERSION": "0.1",
     "SCHEMA_PATH_PREFIX": "/api/rpc/",
     "COMPONENT_NO_READ_ONLY_REQUIRED": True,

rpctracker/settings.py purple/settings.py

@@ -11,6 +11,6 @@
 
 from django.core.wsgi import get_wsgi_application
 
-os.environ.setdefault("DJANGO_SETTINGS_MODULE", "rpctracker.settings")
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "purple.settings")
 
 application = get_wsgi_application()

rpctracker/urls.py purple/urls.py

@@ -1,8 +1,8 @@
 #!/bin/sh -e
 # Run this in the container after updating rpcapi.yaml!
 
-# Generate OpenAPI for the RpcTracker's api
-./manage.py spectacular --file rpctracker_api.yaml
+# Generate OpenAPI schema for the Purple api
+./manage.py spectacular --file purple_api.yaml
 
 # Generate clients
 # Configure the generator in openapitools.json