Initial project setup (#2)

Author: joostlek

.github/workflows/linting.yaml

@@ -120,8 +120,6 @@ jobs:
         run: poetry run pre-commit run check-xml --all-files
       - name: 🚀 Check YAML files
         run: poetry run pre-commit run check-yaml --all-files
-      - name: 🚀 Check YAML files
-        run: poetry run pre-commit run check-yaml --all-files
       - name: 🚀 Detect Private Keys
         run: poetry run pre-commit run detect-private-key --all-files
       - name: 🚀 Check End of Files

.github/workflows/typing.yaml

@@ -32,4 +32,4 @@ jobs:
       - name: 🏗 Install dependencies
         run: poetry install --no-interaction
       - name: 🚀 Run mypy
-        run: poetry run mypy examples src tests
+        run: poetry run mypy src tests

poetry.lock

@@ -1,12 +1,12 @@
-sonar.projectKey=joostlek_python-opensky
+sonar.projectKey=joostlek_python-youtube
 sonar.organization=joostlek-github
-sonar.projectName=Asynchronous Python client for the OpenSky API
+sonar.projectName=Asynchronous Python client for the YouTube V3 API
 sonar.projectVersion=1.0
 
-sonar.links.homepage=https://github.com/joostlek/python-opensky
-sonar.links.ci=https://github.com/joostlek/python-opensky/actions
-sonar.links.issue=https://github.com/joostlek/python-opensky/issues
-sonar.links.scm=https://github.com/joostlek/python-opensky/tree/main
+sonar.links.homepage=https://github.com/joostlek/python-youtube
+sonar.links.ci=https://github.com/joostlek/python-youtube/actions
+sonar.links.issue=https://github.com/joostlek/python-youtube/issues
+sonar.links.scm=https://github.com/joostlek/python-youtube/tree/main
 
 sonar.language=py
 sonar.sourceEncoding=UTF-8

sonar-project.properties

@@ -1,3 +1 @@
 """Asynchronous Python client for the YouTube V3 API."""
-
-__all__ = []

src/python_youtube/__init__.py

@@ -0,0 +1,20 @@
+"""The YouTube API."""
+__all__ = [
+    "YouTube",
+]
+
+
+class YouTube:
+    """YouTube API client."""
+
+    def __init__(self) -> None:
+        """Initialize the YouTube client."""
+        self.test = "ack"
+
+    def syn(self) -> str:
+        """Test method."""
+        return self.test
+
+    def ack(self) -> str:
+        """Test method."""
+        return self.test

src/python_youtube/youtube.py

@@ -0,0 +1,8 @@
+"""Tests for the YouTube Library."""
+from pathlib import Path
+
+
+def load_fixture(filename: str) -> str:
+    """Load a fixture."""
+    path = Path(__package__) / "fixtures" / filename
+    return path.read_text(encoding="utf-8")

tests/__init__.py

@@ -0,0 +1,9 @@
+"""Tests for the YouTube client."""
+from python_youtube.youtube import YouTube
+
+
+async def test_init() -> None:
+    """Test if YouTube client can be created."""
+    youtube = YouTube()
+    assert youtube.syn() == "ack"
+    assert youtube.ack() == "ack"