Initial release setup

Author: TrisNol

.github/workflows/release.yml

@@ -1,48 +1,30 @@
-name: Create and publish a Docker image
-
 on:
   push:
-    branches: ['main', 'dev']
+    # Sequence of patterns matched against refs/tags
+    tags:
+      - 'v*' # Push events to matching v*, i.e. v1.0, v20.15.10
 
-env:
-  REGISTRY: ghcr.io
-  IMAGE_NAME: ${{ github.repository }}
+name: Create Release
 
 jobs:
-  build-and-push-image:
+  build:
+    name: Create Release
     runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      packages: write
-
     steps:
-      - name: Checkout repository
+      - name: Checkout code
         uses: actions/checkout@v2
-
-      - name: Run Snyk to check for vulnerabilities
-        uses: snyk/actions/python-3.8@master
+        
+      - name: Create Release
+        id: create_release
+        uses: actions/create-release@v1
         env:
-          SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}
-        with:
-          args: --severity-threshold=high
-
-      - name: Log in to the Container registry
-        uses: docker/login-action@v1
-        with:
-          registry: ${{ env.REGISTRY }}
-          username: ${{ github.actor }}
-          password: ${{ secrets.GITHUB_TOKEN }}
-
-      - name: Extract metadata (tags, labels) for Docker
-        id: meta
-        uses: docker/metadata-action@v3
-        with:
-          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
-
-      - name: Build and push Docker image
-        uses: docker/build-push-action@v2
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token
         with:
-          context: .
-          push: true
-          tags: ${{ steps.meta.outputs.tags }}
-          labels: ${{ steps.meta.outputs.labels }}
+          tag_name: ${{ github.ref }}
+          release_name: Release ${{ github.ref }}
+          body: |
+            Changes in this Release
+            - First Change
+            - Second Change
+          draft: false
+          prerelease: false

.vscode/settings.json

@@ -1,5 +1,5 @@
 {
     "python.linting.pylintEnabled": false,
-    "python.linting.enabled": true,
+    "python.linting.enabled": false,
     "python.linting.flake8Enabled": true
 }

Dockerfile

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Tristan Nolde
+Copyright (c) 2022 Tristan Nolde
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

LICENSE

@@ -1,8 +1,8 @@
-[![GitHub license](https://img.shields.io/github/license/TrisNol/sample-python-repo.svg)](https://github.com/TrisNol/sample-python-repo/blob/master/LICENSE)
-[![Github all releases](https://img.shields.io/github/downloads/TrisNol/sample-python-repo/total.svg)](https://github.com/users/TrisNol/packages/container/package/sample-python-repo)
-[![GitHub forks](https://img.shields.io/github/forks/TrisNol/sample-python-repo.svg?style=social&label=Fork&maxAge=2592000)](https://github.com/TrisNol/sample-python-repo)
-# Sample Python Repo
-This repo contains a skeleton for Python projects containing some basic DevOps´ components like CI/CD pipelines.
+[![GitHub license](https://img.shields.io/github/license/TrisNol/python-sample-package.svg)](https://github.com/TrisNol/python-sample-package/blob/master/LICENSE)
+[![Github all releases](https://img.shields.io/github/downloads/TrisNol/python-sample-package/total.svg)](https://github.com/users/TrisNol/packages/container/package/python-sample-package)
+[![GitHub forks](https://img.shields.io/github/forks/TrisNol/python-sample-package.svg?style=social&label=Fork&maxAge=2592000)](https://github.com/TrisNol/python-sample-package)
+# Python saple release
+This repo contains a skeleton for Python packages containing some basic DevOps´ components like CI/CD pipelines.
 
 ## Linting
 The code of this repo will be linted with [PyLint](https://pylint.org/) automatically on each push and pull-request to ensure that the files are correctly formatted in order to improve readability.

README.MD

@@ -1,3 +0,0 @@
-# Add other libraries here - the following is just a placeholder
-numpy==1.22.2
-pandas==1.4.1

app/app.py

@@ -0,0 +1,26 @@
+import setuptools
+
+with open("README.md", "r", encoding="utf-8") as fh:
+    long_description = fh.read()
+
+setuptools.setup(
+    name="python-sample-package",
+    version="0.0.1",
+    author="Tristan Nolde",
+    author_email="author@example.com",
+    description="A Python sample package",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/TrisNol/python-sample-package",
+    project_urls={
+        "Bug Tracker": "https://github.com/TrisNol/python-sample-package/issues",
+    },
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+    ],
+    package_dir={"": "src"},
+    packages=setuptools.find_packages(where="src"),
+    python_requires=">=3.8",
+)

requirements.txt

@@ -0,0 +1,11 @@
+
+def add_one(number):
+    """Add 1 to the provided number.
+
+    Args:
+        number (any): Input
+
+    Returns:
+        any: Output
+    """
+    return number+1