docs: add openAPI spec, add nix-shell

config/settings.py

@@ -99,6 +99,7 @@
     "corsheaders",
     "rest_framework",
     "cachalot",
+    "drf_spectacular",
 ) + CUSTOM_APPS
 
 
@@ -116,6 +117,7 @@
     "DEFAULT_PAGINATION_CLASS": "rest_framework.pagination.LimitOffsetPagination",
     "PAGE_SIZE": 20,
     "PAGINATE_BY": 20,
+    "DEFAULT_SCHEMA_CLASS": "drf_spectacular.openapi.AutoSchema",
 }
 
 
@@ -136,3 +138,42 @@
 ]
 
 DEFAULT_AUTO_FIELD = "django.db.models.AutoField"
+
+SPECTACULAR_SETTINGS = {
+    "TITLE": "PokéAPI",
+    "DESCRIPTION": """All the Pokémon data you'll ever need in one place, easily accessible through a modern free open-source RESTful API.
+
+## What is this?
+
+This is a full RESTful API linked to an extensive database detailing everything about the Pokémon main game series.
+
+We've covered everything from Pokémon to Berry Flavors.
+
+## Where do I start?
+
+We have awesome [documentation](https://pokeapi.co/docs/v2) on how to use this API. It takes minutes to get started.
+
+This API will always be publicly available and will never require any extensive setup process to consume.
+
+Created by [**Paul Hallett**(]https://github.com/phalt) and other [**PokéAPI contributors***](https://github.com/PokeAPI/pokeapi#contributing) around the world. Pokémon and Pokémon character names are trademarks of Nintendo.
+    """,
+    "SERVERS": [{"url": "https://pokeapi.co"}],
+    "EXTERNAL_DOCS": {"url": "https://pokeapi.co/docs/v2"},
+    "VERSION": "2.7.0",
+    "SERVE_INCLUDE_SCHEMA": False,
+    "OAS_VERSION": "3.1.0",
+    "COMPONENT_SPLIT_REQUEST": True,
+    "TAGS": [
+        "pokemon",
+        "evolution",
+        "berries",
+        "items",
+        "machines",
+        "location",
+        "contest",
+        "moves",
+        "encounters",
+        "games",
+        "utility",
+    ],
+}

default.nix

@@ -0,0 +1,42 @@
+with import <nixpkgs> { };
+
+let
+  pythonPackages = python3Packages;
+in pkgs.mkShell rec {
+  name = "impurePythonEnv";
+  venvDir = "./.venv";
+  buildInputs = [
+    python310Packages.python
+    python310Packages.venvShellHook
+
+    # python310Packages.coverage
+    # python310Packages.python-mimeparse
+    # python310Packages.python-dateutil
+    # python310Packages.drf-spectacular
+    # python310Packages.djangorestframework
+    # python310Packages.django-redis
+    # python310Packages.django-cors-headers
+
+    # Required dependancies 
+    black
+    taglib
+    openssl
+    git
+    libxml2
+    libxslt
+    libzip
+    zlib
+  ];
+
+  # Run this command, only after creating the virtual environment
+  postVenvCreation = ''
+    unset SOURCE_DATE_EPOCH
+    pip install -r requirements.txt
+  '';
+
+  postShellHook = ''
+    # allow pip to install wheels
+    unset SOURCE_DATE_EPOCH
+  '';
+
+}