🔖 Migrate FastQL to Poetry & Improve DockerFile (#16)

chore(dev): Migrate to Poetry

Author: yezz123

.env.example

@@ -0,0 +1,18 @@
+name: Docker Image
+
+on:
+  push:
+    branches: ["master"]
+  pull_request:
+    branches: ["master"]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Build
+      run: docker build --tag fastql --file docker/Dockerfile .

.github/workflows/build.yml

@@ -0,0 +1,93 @@
+name: Docker
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+on:
+  schedule:
+    - cron: '29 4 * * *'
+  push:
+    branches: [ master ]
+    # Publish semver tags as releases.
+    tags: [ 'v*.*.*' ]
+  pull_request:
+    branches: [ master ]
+
+env:
+  # Use docker.io for Docker Hub if empty
+  REGISTRY: ghcr.io
+  # github.repository as <account>/<repo>
+  IMAGE_NAME: ${{ github.repository }}
+
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+      # This is used to complete the identity challenge
+      # with sigstore/fulcio when running outside of PRs.
+      id-token: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      # Install the cosign tool except on PR
+      # https://github.com/sigstore/cosign-installer
+      - name: Install cosign
+        if: github.event_name != 'pull_request'
+        uses: sigstore/cosign-installer@1e95c1de343b5b0c23352d6417ee3e48d5bcd422
+        with:
+          cosign-release: 'v1.4.0'
+
+
+      # Workaround: https://github.com/docker/build-push-action/issues/461
+      - name: Setup Docker buildx
+        uses: docker/setup-buildx-action@79abd3f86f79a9d68a23c75a09a9a85889262adf
+
+      # Login against a Docker registry except on PR
+      # https://github.com/docker/login-action
+      - name: Log into registry ${{ env.REGISTRY }}
+        if: github.event_name != 'pull_request'
+        uses: docker/login-action@28218f9b04b4f3f62068d7b6ce6ca5b26e35336c
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      # Extract metadata (tags, labels) for Docker
+      # https://github.com/docker/metadata-action
+      - name: Extract Docker metadata
+        id: meta
+        uses: docker/metadata-action@98669ae865ea3cffbcbaa878cf57c20bbf1c6c38
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+
+      # Build and push Docker image with Buildx (don't push on PR)
+      # https://github.com/docker/build-push-action
+      - name: Build and push Docker image
+        id: build-and-push
+        uses: docker/build-push-action@ad44023a93711e3deb337508980b4b5e9bcdc5dc
+        with:
+          context: .
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+
+      # Sign the resulting Docker image digest except on PRs.
+      # This will only write to the public Rekor transparency log when the Docker
+      # repository is public to avoid leaking data.  If you would like to publish
+      # transparency data even for private images, pass --force to cosign below.
+      # https://github.com/sigstore/cosign
+      - name: Sign the published Docker image
+        if: ${{ github.event_name != 'pull_request' }}
+        env:
+          COSIGN_EXPERIMENTAL: "true"
+        # This step uses the identity token to provision an ephemeral certificate
+        # against the sigstore community Fulcio instance.
+        run: cosign sign ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}@${{ steps.build-and-push.outputs.digest }}

.github/workflows/docker-image.yml

@@ -18,11 +18,8 @@ down:
 build:
 	docker-compose build
 
-bash:
-	docker-compose run --rm backend bash
-
-lint:
-	docker-compose run --rm backend pre-commit run --all-files
+test:
+	docker-compose up -d && docker-compose run --rm fastql bash -c "pytest"
 
 clean:
 	find . -name '*.pyc' -exec rm -f {} +

.github/workflows/docker-publish.yml

@@ -1,20 +1,24 @@
-![fastql](.github/header.svg)
+# FastQL - FastAPI GraphQL Playground 🔧
 
-# FastQL - FastAPI GraphQL Playground
+![fastql](.github/header.svg)
 
-Generate a FullStack playground using FastAPI and GraphQL and Ariadne :rocket:.
+<p align="center">
+    <em>Generate a FullStack playground using FastAPI and GraphQL and Ariadne ⚡</em>
+</p>
 
 This Repository is based on this Article [Getting started with GraphQL in Python with FastAPI and Ariadne](https://www.obytes.com/blog/getting-started-with-graphql-in-python-with-fastapi-and-ariadne), Read Article to know how to use it.
 
-## Overview
+## Overview 📌
 
 - FastAPI is a modern, fast (high-performance), web framework for building APIs with Python 3.6+ based on standard Python type hints.
 - GraphQL used to create a schema to describe all the possible data that clients can query through that service. A GraphQL schema is made up of object types, which define which kind of object you can request and what fields it has.
 - Ariadne is a Python library for implementing GraphQL servers using schema-first approach.
 
 ## Features
 
-- Full **Docker** integration (Docker based).
+- Full Docker integration (Docker based).
+- Docker Compose integration and optimization for local development.
+- Production ready Python web server using Uvicorn and Gunicorn.
 - **GraphQL** playground based on Graphene and Ariadne.
 - **Docker Compose** integration and optimization for local development.
 - **Production ready** Python web server using Uvicorn.
@@ -27,11 +31,6 @@ This Repository is based on this Article [Getting started with GraphQL in Python
 
 ## Getting Started
 
-### Prerequisites
-
-- Python 3.8.6 or higher.
-- Docker.
-
 ### Project setup
 
 ```sh
@@ -42,21 +41,6 @@ $ git clone https://github.com/obytes/fastql.git
 $ cd fastql
 ```
 
-### Creating virtual environment
-
-- Create a virtual environment using virtualenv.
-
-```shell
-# creating virtual environment
-$ virtualenv venv
-
-# activate virtual environment
-$ source venv/bin/activate
-
-# install all dependencies
-$ pip install -r requirements.txt
-```
-
 ## Running the Docker Container
 
 - We have the Dockerfile created in above section. Now, we will use the Dockerfile to create the image of the FastAPI app and then start the FastAPI app container.
@@ -77,36 +61,6 @@ $ make start
 
 While i use `HTTPX` an HTTP client for Python 3, to test the API, most of the tests are using a live log thats why need before to run a server using `uvicorn` and migrate the database, then you will have the ability to run the tests. To have a clean environment, recommended to use Docker for that, when you start the containers try to open the application container and then run `pytest` to test the API.
 
-### Environment variables
-
-```sh
-SECRET_KEY #Secret Key
-QUEUE # RabbitMQ Link
-DATABASE_URL # Database URL
-ACCESS_TOKEN_EXPIRE_SECONDS # Access Token Expire Seconds
-```
-
-> change all the environment variables in the `.env.example` and don't forget to rename it to `.env`.
-
-## Preconfigured Packages
-
-Includes preconfigured packages to kick start FastQL by just setting appropriate configuration.
-
-| Package                                                      | Usage                                                            |
-| ------------------------------------------------------------ | ---------------------------------------------------------------- |
-| [FastAPI](https://fastapi.tiangolo.com/)                    | FastAPI is a modern, fast (high-performance), web framework for developing APIs with Python 3.6+ based on standard Python type hints. |
-| [GraphQL](https://graphql.org/)                             | GraphQL used to create a schema to describe all the possible data that clients can query through that service. A GraphQL schema is made up of object types, which define which kind of object you can request and what fields it has. |
-| [Ariadne](https://ariadnegraphql.org/)                       | Ariadne is a Python library for implementing GraphQL servers using schema-first approach. |
-
-## Contributing
-
-- If you have any questions or suggestions, please open an issue or create a pull request.
-- If you are a contributor, please check out:
-  - Is your pull request or issue relate with FastAPI?
-  - Is your pull request or issue relate with GraphQL?
-  - And make sure you take a look at the schema of the GraphQL playground. [schema.graphql](graphql/schema.graphql)
-  - Also for People who gonna add a new features or fix somethings please make sure that its build on Docker.
-
 ## License
 
-This project is licensed under the terms of the MIT license.
+This project is licensed under the terms of the MIT license.

Dockerfile

@@ -50,7 +50,7 @@ version_path_separator = os  # default: use os.pathsep
 # are written from script.py.mako
 # output_encoding = utf-8
 
-sqlalchemy.url = postgresql://postgres:password@localhost/fastql
+sqlalchemy.url = postgresql://postgres:postgres@localhost/FastQL
 
 
 [post_write_hooks]

Makefile

@@ -2,10 +2,10 @@
 
 from ariadne import MutationType, convert_kwargs_to_snake_case
 
-from core import crud, rabbit
-from database import config, data
-from schemas import security
-from schemas.error import MyGraphQLError
+from app.core import crud, rabbit
+from app.database import config, data
+from app.schemas import security
+from app.schemas.error import MyGraphQLError
 
 
 @convert_kwargs_to_snake_case