Configure pipelines (build, test, lint, docs)

.github/workflows/build-push-image.yml

@@ -0,0 +1,28 @@
+name: Build and Push Docker Image
+on: 
+  push:
+    branches:
+      - '*'
+
+env:
+  DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
+  DOCKERHUB_TOKEN: ${{ secrets.DOCKERHUB_TOKEN }}
+
+jobs:
+  build-and-push:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Login to Docker Hub
+        uses: docker/login-action@v1
+        with:
+          username: ${{ env.DOCKERHUB_USERNAME }}
+          password: ${{ env.DOCKERHUB_TOKEN }}
+      - name: Build Docker image
+        run: |
+          docker build -t bark:latest .
+      - name: Push Docker image
+        run: |
+          docker tag bark:latest ${{ env.DOCKERHUB_USERNAME }}/bark:latest
+          docker push ${{ env.DOCKERHUB_USERNAME }}/bark:latest

.github/workflows/generate-sphinx-doc.yml

@@ -0,0 +1,18 @@
+name: Docs Build And Check
+on: 
+  push:
+    branches:
+      - '*'
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: ammaraskar/sphinx-action@master
+      with:
+        docs-folder: "docs/"
+    - uses: actions/upload-artifact@v1
+      with:
+        name: DocumentationHTML
+        path: docs/build/html/

.github/workflows/lint.yml

@@ -0,0 +1,18 @@
+name: Python Linter
+on: 
+  push:
+    branches:
+      - '*'
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2  
+      - name: Python Linter
+        uses: sunnysid3up/python-linter@master
+        with:
+          source: "bark"
+          mypy-options: "--ignore-missing-imports --show-error-codes"
+          pylint-options: "--rcfile=setup.cfg"
+          isort-options: "-w 100"

.github/workflows/unit-test.yml

@@ -0,0 +1,25 @@
+name: Unit Test
+on: 
+  push:
+    branches:
+      - '*'
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.11.3'
+    - name: Install dependencies
+      run: |
+        sudo apt update -y
+        sudo apt install -y python3-pip
+
+        pip3 install .
+        pip3 install -e '.[dev]' 
+    - name: Test with pytest
+      run: |
+        pytest

Dockerfile

@@ -0,0 +1,25 @@
+# Copyright (c) Meta, Inc. and its affiliates.
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+FROM ubuntu:22.04
+
+# Installing the required packages
+RUN apt update -y
+RUN apt install -y git curl
+RUN apt install -y python3-pip
+
+WORKDIR /root
+
+COPY . .
+
+# Download the Bark Github repo
+RUN git clone https://github.com/luis-furtado/bark-with-voice-clone.git ~/app
+
+RUN cd ~/app
+
+# Install dependencies and dev dependencies to run tests
+RUN cd ~/app && \
+    pip3 install . && \
+    pip3 install -e '.[dev]' 
+
+CMD ["python3", "setup.py", "--help"]

bark/test_sample.py

@@ -0,0 +1,5 @@
+def func(x):
+    return x + 1
+
+def test_answer():
+    assert func(4) == 5

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/bark.rst

@@ -0,0 +1,45 @@
+bark package
+============
+
+Submodules
+----------
+
+bark.api module
+---------------
+
+.. automodule:: bark.api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+bark.generation module
+----------------------
+
+.. automodule:: bark.generation
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+bark.model module
+-----------------
+
+.. automodule:: bark.model
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+bark.model\_fine module
+-----------------------
+
+.. automodule:: bark.model_fine
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: bark
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/build/html/.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 3c3a45f7380646673145bdabaed7ce09
+tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/build/html/_sources/bark.rst.txt

@@ -0,0 +1,45 @@
+bark package
+============
+
+Submodules
+----------
+
+bark.api module
+---------------
+
+.. automodule:: bark.api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+bark.generation module
+----------------------
+
+.. automodule:: bark.generation
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+bark.model module
+-----------------
+
+.. automodule:: bark.model
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+bark.model\_fine module
+-----------------------
+
+.. automodule:: bark.model_fine
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: bark
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/build/html/_sources/index.rst.txt

@@ -0,0 +1,20 @@
+.. Bark documentation master file, created by
+   sphinx-quickstart on Tue Jun 27 10:35:37 2023.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Bark's documentation!
+================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/build/html/_sources/modules.rst.txt

@@ -0,0 +1,7 @@
+bark
+====
+
+.. toctree::
+   :maxdepth: 4
+
+   bark