Add requirements

Reviewed-on: #1

.gitea/workflows/flake8.yml

@@ -0,0 +1,17 @@
+---
+name: Flake8
+on: [push]
+
+
+# XXX need to do stuff with uv
+jobs:
+  build:
+    runs-on: freebsd
+    strategy:
+      matrix:
+        python-version: ["3.11"]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Analyse code with Flake8
+        run: |
+          flake8 $(git ls-files '*.py')

.gitea/workflows/mypy.yml

@@ -0,0 +1,17 @@
+---
+name: Mypy
+on: [push]
+
+
+# XXX need to do stuff with uv
+jobs:
+  build:
+    runs-on: freebsd
+    strategy:
+      matrix:
+        python-version: ["3.11"]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Analyse code with Mypy
+        run: |
+          mypy --install-types --non-interactive $(git ls-files '*.py')

.gitea/workflows/pylint.yml

@@ -0,0 +1,17 @@
+---
+name: Pylint
+on: [push]
+
+
+# XXX need to do stuff with uv
+jobs:
+  build:
+    runs-on: freebsd
+    strategy:
+      matrix:
+        python-version: ["3.11"]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Analyse code with Pylint
+        run: |
+          pylint $(git ls-files '*.py')

app/main.py

@@ -15,11 +15,13 @@ app = FastAPI()
 GEOLITE2_ASN_DB = '/usr/local/share/GeoIP/GeoLite2-ASN.mmdb'
 GEOLITE2_CITY_DB = '/usr/local/share/GeoIP/GeoLite2-City.mmdb'
 
+
 class IPAddressParam(BaseModel):
     '''
     Payload entry as used in POST
     '''
-    ip: Union[IPv6Address,IPv4Address]
+    ip: Union[IPv6Address, IPv4Address]
+
 
 class Locality(BaseModel):
     '''
@@ -30,19 +32,23 @@ class Locality(BaseModel):
     continent: Optional[str] = None
     is_eu: bool = False
 
+
 class GeoLocation(BaseModel):
     '''
     Geolocation data model
     '''
-    ip: Optional[Union[IPv6Address,IPv4Address]] = None
+    ip: Optional[Union[IPv6Address, IPv4Address]] = None
     asn: Optional[int] = None
     asn_org: Optional[str] = None
-    network: Optional[Union[IPv6Network,IPv4Network]] = None
+    network: Optional[Union[IPv6Network, IPv4Network]] = None
     locality: Locality = Locality()
 
+
 @app.post("/")
-async def root_post(ipaddresses: Annotated[list[IPAddressParam],
-                                    Body(title="The IPAddresses to geolocate")]
+async def root_post(ipaddresses: Annotated[
+    list[IPAddressParam],
+    Body(title="The IPAddresses to geolocate")],
+                    response: Response
                     ) -> list[GeoLocation]:
     '''
     Return GeoLocation item(s) for a list of IPAddressParam objects
@@ -72,26 +78,31 @@ async def root_post(ipaddresses: Annotated[list[IPAddressParam],
                     ip=ipaddress.ip
                     )
                 )
+    if geolocations:
+        response.headers['Cache-Control'] = 'private, max-age=604800'
     return geolocations
 
 
 @app.get("/{ipaddress}")
-async def root_get(ipaddress: Annotated[Union[IPv4Address,IPv6Address],
+async def root_get(ipaddress: Annotated[
+    Union[IPv4Address, IPv6Address],
     Path(title="The IPAddress to geolocate")],
                    response: Response
                    ) -> GeoLocation:
     '''
     Look up geolocation for ip in path parameter
     '''
-    locations = await root_post([IPAddressParam(ip=ipaddress)])
+    locations = await root_post([IPAddressParam(ip=ipaddress)], response)
     if locations:
+        response.headers['Cache-Control'] = 'private, max-age=604800'
         return locations.pop()
     response.status_code = status.HTTP_404_NOT_FOUND
     return GeoLocation()
 
+
 @app.get("/")
 def root_redirect(req: Request) -> RedirectResponse:
     '''
     Redirect empty request using REMOTE_ADDR
     '''
-    return RedirectResponse(url= str(req.url) + str(req.client.host))
+    return RedirectResponse(url=str(req.url) + str(req.client.host))

requirements.txt

@@ -0,0 +1,2 @@
+geoip2==4.7.0
+fastapi==0.115.6