chore(API): rename project to be Prowler API (#22)

.pre-commit-config.yaml

@@ -72,7 +72,7 @@ repos:
       - id: bandit
         name: bandit
         description: "Bandit is a tool for finding common security issues in Python code"
-        entry: bash -c 'poetry run bandit -q -lll -x '*_test.py,./contrib/' -r .'
+        entry: bash -c 'poetry run bandit -q -lll -x '*_test.py,./contrib/,./.venv/' -r .'
         language: system
         files: '.*\.py'
 
@@ -85,6 +85,6 @@ repos:
       - id: vulture
         name: vulture
         description: "Vulture finds unused code in Python programs."
-        entry: bash -c 'poetry run vulture --exclude "contrib" --min-confidence 100 .'
+        entry: bash -c 'poetry run vulture --exclude "contrib,.venv" --min-confidence 100 .'
         language: system
         files: '.*\.py'

Dockerfile

@@ -1,6 +1,6 @@
 FROM python:3.12-alpine as build
 
-LABEL maintainer="https://github.com/prowler-cloud/restful-api"
+LABEL maintainer="https://github.com/prowler-cloud/api"
 
 RUN apk --no-cache upgrade && \
     addgroup -g 1000 prowler && \

README.md

@@ -50,10 +50,10 @@ This method requires installing a Python virtual environment and keep dependenci
 
 ```console
 # HTTPS
-git clone https://github.com/prowler-cloud/restful-api.git
+git clone https://github.com/prowler-cloud/api.git
 
 # SSH
-git clone git@github.com:prowler-cloud/restful-api.git
+git clone git@github.com:prowler-cloud/api.git
 
 ```
 
@@ -85,10 +85,10 @@ This method requires `docker` and `docker compose`.
 
 ```console
 # HTTPS
-git clone https://github.com/prowler-cloud/restful-api.git
+git clone https://github.com/prowler-cloud/api.git
 
 # SSH
-git clone git@github.com:prowler-cloud/restful-api.git
+git clone git@github.com:prowler-cloud/api.git
 
 ```
 

docker-compose.yml

@@ -1,8 +1,8 @@
 services:
-  restful-api:
+  api:
     build:
       dockerfile: Dockerfile
-    image: prowler-restful-api
+    image: prowler-api
     env_file:
       - path: ./.env
         required: false
@@ -17,11 +17,11 @@ services:
       - "../docker-entrypoint.sh"
       - "prod"
 
-  restful-api-dev:
+  api-dev:
     build:
       dockerfile: Dockerfile
       target: dev
-    image: prowler-restful-api-dev
+    image: prowler-api-dev
     environment:
       - DJANGO_SETTINGS_MODULE=config.django.devel
       - DJANGO_LOGGING_FORMATTER=human_readable

pyproject.toml

@@ -4,9 +4,9 @@ requires = ["poetry-core"]
 
 [tool.poetry]
 authors = ["Prowler Team"]
-description = "Prowler's RESTful API (Django/DRF)"
+description = "Prowler's API (Django/DRF)"
 license = "AGPL-3.0"
-name = "prowler-rest-api"
+name = "prowler-api"
 package-mode = false
 version = "1.0.0"
 

src/backend/api/specs/v1.yaml

@@ -1,9 +1,9 @@
 openapi: 3.0.3
 info:
-  title: Prowler RESTful API
+  title: Prowler API
   version: 1.0.0
   description: |-
-    Prowler RESTful API specification.
+    Prowler API specification.
 
     This file is auto-generated.
 paths:

src/backend/api/views/v1/views.py

@@ -31,10 +31,10 @@ class SchemaView(SpectacularAPIView):
     serializer_class = None
 
     def get(self, request, *args, **kwargs):
-        spectacular_settings.TITLE = "Prowler RESTful API"
+        spectacular_settings.TITLE = "Prowler API"
         spectacular_settings.VERSION = "1.0.0"
         spectacular_settings.DESCRIPTION = (
-            "Prowler RESTful API specification.\n\nThis file is auto-generated."
+            "Prowler API specification.\n\nThis file is auto-generated."
         )
         return super().get(request, *args, **kwargs)