Merge pull request #3 from InnerSourceCommons/packaging

ci: update workflows

Author: 3cpt

.github/workflows/pylint.yml .github/workflows/checker.yml.github/workflows/pylint.yml renamed to .github/workflows/checker.yml

@@ -1,4 +1,4 @@
-name: Pylint
+name: checker
 
 on: [push]
 
@@ -14,10 +14,13 @@ jobs:
       uses: actions/setup-python@v2
       with:
         python-version: ${{ matrix.python-version }}
-    - name: Install dependencies
+    - name: install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install pylint
-    - name: Analysing the code with pylint
+        make install
+    - name: flake8 lint
       run: |
-        pylint `ls -R|grep .py$|xargs`
+        make lint
+    - name: check code format
+      run: |
+        make check-format

.github/workflows/python-publish.yml

@@ -1,12 +1,4 @@
-# This workflow will upload a Python Package using Twine when a release is created
-# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
-
-# 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.
-
-name: Upload Python Package
+name: upload Python package
 
 on:
   release:
@@ -23,14 +15,12 @@ jobs:
       uses: actions/setup-python@v2
       with:
         python-version: '3.x'
-    - name: Install dependencies
+    - name: install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install build
-    - name: Build package
-      run: python -m build
-    #- name: Publish package
-    #  uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
-    #  with:
-    #    user: __token__
-    #    password: ${{ secrets.PYPI_API_TOKEN }}
+        make install
+    - name: publish to pypi
+      uses: pypa/gh-action-pypi-publish@master
+      with:
+        skip_existing: true
+        password: ${{ secrets.PYPI_TOKEN }}  

Makefile

@@ -0,0 +1,23 @@
+#!make
+	
+define USAGE
+Commands:
+    check-format                Check code formats
+    install                     Install requirements.txt dependencies
+    lint                        Run linter (flake8)
+    test                        Run tests and validate project
+endef
+
+export USAGE
+
+help:
+	@echo "$$USAGE"
+
+lint:
+	@flake8 --ignore E501,W503,E203
+
+install:
+	@pip3 install -r requirements.txt
+
+check-format:
+	@black --check .

pyproject.toml

@@ -0,0 +1,6 @@
+[build-system]
+requires = [
+    "setuptools>=42",
+    "wheel"
+]
+build-backend = "setuptools.build_meta"

requirements.txt

@@ -0,0 +1,4 @@
+flake8==4.0.1
+black==21.10b0
+bump2version==1.0.1
+

setup.cfg

@@ -0,0 +1,24 @@
+[metadata]
+name = repo-activity-score
+version = 0.0.1
+author = André Correia & InnerSourceCommons
+author_email = andrecorreia@pm.me
+description = Python implementation of the InnerSourceCommons Repository Activity Score pattern algorithm
+long_description = file: README.md
+long_description_content_type = text/markdown
+url = https://github.com/InnerSourceCommons/repo-activity-score
+project_urls =
+    Bug Tracker = https://github.com/InnerSourceCommons/repo-activity-score/issues
+classifiers =
+    Programming Language :: Python :: 3
+    License :: OSI Approved :: MIT License
+    Operating System :: OS Independent
+
+[options]
+package_dir =
+    = src
+packages = find:
+python_requires = >=3.6
+
+[options.packages.find]
+where = src

src/repo_score/score.py

@@ -2,41 +2,62 @@
 import math
 import functools
 
+
 def calculate_score(repo):
     # initial score is 50 to give active repos with low GitHub KPIs (forks, watchers, stars) a better starting point
     iScore = float(50)
 
     # weighting: forks and watches count most, then stars, add some little score for open issues, too
     iScore += repo["forks_count"] * 5
-    iScore += 'subscribers_count' in repo or 0
+    iScore += "subscribers_count" in repo or 0
     iScore += repo["stargazers_count"] / 3
     iScore += repo["open_issues_count"] / 5
 
     # updated in last 3 months: adds a bonus multiplier between 0..1 to overall score (1 = updated today, 0 = updated more than 100 days ago)
-    iDaysSinceLastUpdate = (datetime.datetime.now().timestamp() - datetime.datetime.strptime(repo['updated_at'], '%Y-%m-%dT%H:%M:%SZ').timestamp()) / 86400
+    iDaysSinceLastUpdate = (
+        datetime.datetime.now().timestamp()
+        - datetime.datetime.strptime(
+            repo["updated_at"], "%Y-%m-%dT%H:%M:%SZ"
+        ).timestamp()
+    ) / 86400
     iScore = iScore * ((1 + (100 - min(iDaysSinceLastUpdate, 100))) / 100)
 
     # evaluate participation stats for the previous  3 months
-    if repo['_InnerSourceMetadata']: repo['_InnerSourceMetadata'] or {}
+    if repo["_InnerSourceMetadata"]:
+        repo["_InnerSourceMetadata"] or {}
 
-    if 'participation' in repo['_InnerSourceMetadata']:
+    if "participation" in repo["_InnerSourceMetadata"]:
         # average commits: adds a bonus multiplier between 0..1 to overall score (1 = >10 commits per week, 0 = less than 3 commits per week)
-        sliced = repo['_InnerSourceMetadata']['participation'][len(repo['_InnerSourceMetadata']['participation']) - 13:]
+        sliced = repo["_InnerSourceMetadata"]["participation"][
+            len(repo["_InnerSourceMetadata"]["participation"]) - 13 :
+        ]
 
-        iAverageCommitsPerWeek = functools.reduce(lambda a, b: a+b, sliced) / 13
+        iAverageCommitsPerWeek = functools.reduce(lambda a, b: a + b, sliced) / 13
 
         iScore = iScore * ((1 + (min(max(iAverageCommitsPerWeek - 3, 0), 7))) / 7)
 
     # boost calculation:
     # all repositories updated in the previous year will receive a boost of maximum 1000 declining by days since last update
-    iBoost = (1000 - min(iDaysSinceLastUpdate, 365) * 2.74)
+    iBoost = 1000 - min(iDaysSinceLastUpdate, 365) * 2.74
     # gradually scale down boost according to repository creation date to mix with "real" engagement stats
-    iDaysSinceCreation = (datetime.datetime.now().timestamp() - datetime.datetime.strptime(repo['created_at'], '%Y-%m-%dT%H:%M:%SZ').timestamp()) / 86400
+    iDaysSinceCreation = (
+        datetime.datetime.now().timestamp()
+        - datetime.datetime.strptime(
+            repo["created_at"], "%Y-%m-%dT%H:%M:%SZ"
+        ).timestamp()
+    ) / 86400
     iBoost *= (365 - min(iDaysSinceCreation, 365)) / 365
     # add boost to score
     iScore += iBoost
     # give projects with a meaningful description a static boost of 50
-    if len(repo["description"]) > 30 and repo["_InnerSourceMetadata"] or ("motivation" in repo["_InnerSourceMetadata"] and repo["_InnerSourceMetadata"]["motivation"].length > 30):
+    if (
+        len(repo["description"]) > 30
+        and repo["_InnerSourceMetadata"]
+        or (
+            "motivation" in repo["_InnerSourceMetadata"]
+            and repo["_InnerSourceMetadata"]["motivation"].length > 30
+        )
+    ):
         iScore += 50
     # give projects with contribution guidelines (CONTRIBUTING.md) file a static boost of 100
     if repo["_InnerSourceMetadata"] and "guidelines" in repo["_InnerSourceMetadata"]:
@@ -46,8 +67,8 @@ def calculate_score(repo):
         iScore = 3000 + math.log(iScore) * 100
     # final score is a rounded value starting from 0 (subtract the initial value)
     iScore = round(iScore - 50)
-    
+
     # add score to metadata on the fly
-    repo['_InnerSourceMetadata']['score'] = iScore
+    repo["_InnerSourceMetadata"]["score"] = iScore
 
     return iScore