Merge pull request #1 from SAnCherepan/develop

v0.2.0

Author: SAnCherepan

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 SAnCherepan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1 +1,26 @@
-# Test-code
+# Repo reader
+
+This is a simple example package that can be used to get basic info on GitHub repository groups (a.k.a. organisations).
+
+# Installation
+
+Install the python package:
+```
+python -m pip install --index-url https://test.pypi.org/simple/ repo_reader_sancherepan
+```
+
+
+# Usage
+
+In your code:
+```python
+from repo_reader_sancherepan.repo_reader import RepoReader
+
+reader = RepoReader("<your_github_auth_token>")
+repos = reader.read_repos("<github_repo_group_name>")
+```
+
+In command line:
+```commandline
+read-repos your_github_auth_token github_repo_group_name
+```

docker/Dockerfile

@@ -0,0 +1 @@
+# ToDo: write Dockerfile

pyproject.toml

@@ -0,0 +1,26 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "repo_reader_sancherepan"
+version = "0.2.0"
+authors = [
+  { name="SAnCherepan", email="sivkinpunk@gmail.com" },
+]
+description = "A small example package for reading basic GitHub repo data"
+license = {file = "LICENSE.md"}
+readme = "README.md"
+requires-python = ">=3.11"
+classifiers = [
+    "Development Status :: 2 - Pre-Alpha",
+    "Programming Language :: Python :: 3.11",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+
+[project.urls]
+"Homepage" = "https://github.com/sancherepan/test-code"
+
+[project.scripts]
+read-repos = "repo_reader_sancherepan.print_repos_info:main"

requirements.txt

@@ -0,0 +1 @@
+requests

src/repo_reader_sancherepan/__init__.py

@@ -0,0 +1,11 @@
+class Branch(object):
+    def __init__(self, data):
+        if "name" in data:
+            self.name = data["name"]
+        else:
+            raise ValueError("bad repository data: expected name")
+
+        if "protected" in data:
+            self.protected = data["protected"]
+        else:
+            raise ValueError("bad repository data: expected protected")

src/repo_reader_sancherepan/branch.py

@@ -0,0 +1,29 @@
+import sys
+import argparse
+from .repo_reader import RepoReader
+
+
+def main(args=None):
+    parser = argparse.ArgumentParser()
+    parser.add_argument('auth_token', help='<your_github_auth_token>')
+    parser.add_argument('org_name', help="<github_repo_group_name>")
+
+    if args is None:
+        args = sys.argv[1:]
+
+    args = parser.parse_args(args)
+    auth_token = args.auth_token
+    org_name = args.org_name
+
+    reader = RepoReader(auth_token)
+    repos = reader.read_repos(org_name)
+
+    for repo in repos:
+        print(f"repo: {repo.name}, "
+              f"size: {repo.size}, "
+              f"open_issues: {repo.open_issues_count}, "
+              f"branches: {len(repo.branches)}\n")
+
+
+if __name__ == '__main__':
+    sys.exit(main(sys.argv))

src/repo_reader_sancherepan/print_repos_info.py

@@ -0,0 +1,24 @@
+import requests
+from .repository import Repository
+
+
+class RepoReader:
+
+    github_base_url = "https://api.github.com"
+
+    github_org_repos_url = "/orgs/{}/repos"
+
+    def __init__(self, auth_token):
+        self.session = requests.Session()
+        self.session.headers.update({"Authorization": f"Bearer {auth_token}",
+                                     "Accept": "application/vnd.github+json"})
+
+    def read_repos(self, org_name: str):
+        url = self.github_base_url + self.github_org_repos_url.format(org_name)
+        
+        response = self.session.get(url)
+        response.raise_for_status()
+
+        repos = [Repository(self.session, repo_data) for repo_data in response.json()]
+
+        return repos

src/repo_reader_sancherepan/repo_reader.py

@@ -0,0 +1,39 @@
+import requests
+from .branch import Branch
+
+
+class Repository(object):
+    """
+    A GitHub repository with some basic properties
+    """
+    session: requests.Session
+
+    def __init__(self, session, data: dict):
+        self.session = session
+
+        if "name" in data:
+            self.name = data["name"]
+        else:
+            raise ValueError("bad repository data: expected name")
+
+        if "size" in data:
+            self.size = data["size"]
+        else:
+            raise ValueError("bad repository data: expected size")
+
+        if "open_issues_count" in data:
+            self.open_issues_count = data["open_issues_count"]
+        else:
+            raise ValueError("bad repository data: expected open_issues_count")
+
+        if "url" in data:
+            self.count_branches(data["url"])
+        else:
+            self.branches = None
+
+    def count_branches(self, repo_url):
+        url = f"{repo_url}/branches"
+        response = self.session.get(url)
+        response.raise_for_status()
+
+        self.branches = [Branch(branch_data) for branch_data in response.json()]