Initial Code & readme

Author: vlee489

.github/workflows/ci.yml

@@ -0,0 +1,37 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - master
+  workflow_dispatch:
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
+
+jobs:
+  docker-image:
+    runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/master'
+
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Log in to the Container registry
+        uses: docker/login-action@v3
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}

Dockerfile

@@ -0,0 +1,7 @@
+FROM python:3.13
+WORKDIR /code
+COPY ./requirements.txt /code/requirements.txt
+RUN pip install --no-cache-dir --upgrade -r /code/requirements.txt
+COPY ./restapi /code/restapi
+
+CMD ["python", "-m", "restapi"]

README.md

@@ -1,2 +1,73 @@
 # ampq-restapi
 A simple restapi for sending messages to an ampq based message broker
+
+This app is a simple REST API that allows you to send messages to an AMQP-based message broker.  based on aiopika and
+FastAPI.
+
+This was designed to be used with RabbitMQ, but likely will work with any AMQP-based message broker.
+
+## Usage
+### Dependencies
+- Python 3.11+
+- pip
+
+### Environment Variables
+- `RPC_URI`: The URI of the message broker. E.G `amqp://guest:guest@localhost/`
+- `PORT`: The port to run the application on. (Default: 2000)
+
+### Docker
+You cause pull the container from Github container registry
+```bash
+docker pull ghcr.io/iplsplatoon/ampq-restapi:master
+```
+
+or use `ghcr.io/iplsplatoon/ampq-restapi:master` as the image name in your docker-compose file.
+
+### Install: Bare Metal
+1. Install python dependencies with pip
+    ```bash
+    pip install -r requirements.txt
+    ```
+
+3. Run the application
+    ```bash
+    python -m restapi
+    ```
+   
+### Making requests
+The application will run on port 2000 by default.
+
+#### Docs
+The application is documented using OpenAPI. 
+You can view the documentation by navigating to `http://localhost:2000/docs` in your web browser.
+
+#### Send a message
+You can make a **POST** request to the `/rpc/response` endpoint with the following query parameters:
+
+- `routing_key`: The routing key to use for the message. This is a required parameter.
+- `timeout`: The timeout for the request in seconds. (Default: Never)
+
+You message body should be what ever you want to be sent, the app will convert this to a byte string and send it as the
+message body. We also use the `content_type` header to set the content type of the message that send to the message broken.
+
+The response will be send back to what ever client you using back and will forward the body, headers and other 
+properties from the response message.
+
+_If you don't need a response, you can use the `/rpc/one_way` endpoint instead._
+
+## Development
+
+### Dependencies
+PDM is used for dependency management. 
+
+To install dependencies, run the following command:
+```bash
+pdm install
+```
+
+### Linting
+We use `ruff` for linting and formatting. You can run the following command to lint and format the code:
+```bash
+ruff check
+ruff format
+```