Add Initial Documentation and Contributor Guide for Youtool Project

.dockerignore

@@ -13,7 +13,6 @@
 .gitignore
 .pytest_cache
 Dockerfile
-README.md
 build
 data
 dist

.github/workflows/ci.yaml

@@ -0,0 +1,22 @@
+name: CI
+
+on: [ push, pull_request ]
+
+jobs:
+  ci:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Install poetry
+      run: pip install poetry==1.7.1
+    - name: Set up Python 3.11
+      uses: actions/setup-python@v5
+      with:
+        python-version: 3.11
+        cache: 'poetry'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        poetry install -vv
+    - name: Test
+      run: pytest

.readthedocs.yaml

@@ -0,0 +1,35 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+    # You can also specify other tool versions:
+    # nodejs: "20"
+    # rust: "1.70"
+    # golang: "1.20"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+  # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
+  # builder: "dirhtml"
+  # Fail on all warnings to avoid broken references
+  # fail_on_warning: true
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#   - pdf
+#   - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+# python:
+#   install:
+#     - requirements: docs/requirements.txt

CONTRIBUTING.rst

@@ -0,0 +1,120 @@
+How to contribute to Youtool
+============================
+
+Thank you for considering to Youtool!
+
+First time setup in your local environment:
+-------------------------------------------
+
+- Make sure you have a `GitHub account <https://github.com/>`_
+
+- Fork Youtool to your GitHub account by clicking the `Fork <https://github.com/PythonicCafe/youtool/fork>`_ button
+
+- `Clone <https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo#step-2-create-a-local-clone-of-your-fork>`_ your fork locally, replacing your-username in the command below with your actual username
+
+.. code-block::
+
+    git clone https://github.com/your-username/youtool
+    cd youtool
+
+Installation Poetry
+-------------------
+To manage dependencies and packaging for the project, we use Poetry. 
+- Please follow the installation instructions provided in the `poetry <https://python-poetry.org/docs/#installation>`_
+
+
+Setting Up the Virtual Environment
+----------------------------------
+- After installing Poetry, you need to set up the virtual environment for the project. Navigate to the project directory and run the following command:
+
+.. code-block::
+
+    poetry shell
+
+This command will create and activate a virtual environment for the project.
+
+
+Installing Dependencies
+-----------------------
+- Once the virtual environment is activated, you can install the project dependencies by running:
+
+.. code-block::
+
+    poetry install
+
+This command will install all the dependencies listed in the pyproject.toml file.
+
+
+Creating a Local Branch from a Remote Branch
+--------------------------------------------
+To start contributing, you need to create a local branch based on a remote branch. 
+Use the following commands to achieve this:
+1. Fetch the latest changes from the remote repository:
+
+.. code-block::
+
+    git fetch origin
+
+2. Create and switch to a new branch based on the remote branch:
+
+.. code-block::
+
+    git checkout -b <new-branch-name> origin/<remote-branch-name>
+
+Push your commits to your fork on GitHub and `create a pull request <https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request>`_. Link to the issue being addressed with fixes #123 in the pull request description.
+
+.. code-block::
+
+    git push --set-upstream origin nome-do-seu-branch
+
+Replace <new-branch-name> with your desired branch name and <remote-branch-name> with the name of the remote branch you want to base your work on.
+
+By following these steps, you'll have a local branch set up and ready for your contributions.
+
+
+Running Tests
+-------------
+Before submitting your changes, it's important to run the tests to ensure everything is working correctly. 
+Depending on whether you are inside or outside the virtual environment, use one of the following commands:
+
+1. Inside the virtual environment:
+If you have already activated the virtual environment with poetry shell, run:
+
+.. code-block::
+
+    pytest
+
+2. Outside the virtual environment:
+If you are not inside the virtual environment, you can still run the tests using Poetry:
+
+.. code-block::
+
+    poetry run pytest
+
+By following these steps, you'll ensure that all tests are run correctly before submitting your contributions.
+
+Updating Documentation
+----------------------
+Our documentation is hosted on Read the Docs, and the configuration files are located in the docs directory. To update the documentation, follow these steps:
+
+1. Navigate to the docs directory:
+
+.. code-block::
+
+    cd docs
+
+2. Make your changes:
+    Edit the necessary files to update the documentation. 
+    The main configuration file is typically conf.py, but you may also need to update other ``.rst`` files as required.
+
+3. Build the documentation locally:
+    After making your changes, you can build the HTML version of the documentation to preview your updates. 
+    Run the following command:
+
+.. code-block::
+
+    make html
+
+Open ``_build/html/index.html`` in your browser to view the docs.
+
+Read more about `Sphinx <https://www.sphinx-doc.org/en/master/>`_.

Dockerfile

@@ -11,12 +11,12 @@ RUN apt update \
   && apt clean \
   && rm -rf /var/lib/apt/lists/*
 
-COPY requirements/ /app/requirements
-RUN pip install --no-cache-dir -U pip \
-  && pip install --no-cache-dir -r /app/requirements/base.txt \
-  && pip install --no-cache-dir -r /app/requirements/cli.txt \
-  && pip install --no-cache-dir -r /app/requirements/livechat.txt \
-  && pip install --no-cache-dir -r /app/requirements/transcription.txt \
-  && if [ "$DEV_BUILD" = "true" ]; then pip install --no-cache-dir -r /app/requirements/dev.txt; fi
-
 COPY . /app/
+
+RUN pip install --no-cache-dir -U --upgrade pip \
+  && if [ "$DEV_BUILD" = "true" ]; \
+  then \
+    pip install poetry==1.4.2; \
+    poetry export -f requirements.txt --output requirements.txt --without-hashes --with dev; \
+    pip install --no-cache-dir -r requirements.txt; \
+  else pip install /app; fi

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/conf.py

@@ -0,0 +1,27 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'Youtool'
+copyright = '2024, Álvaro Justen'
+author = 'Álvaro Justen'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = ["myst_parser"]
+
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'alabaster'
+html_static_path = ['_static']

docs/contributing.rst

@@ -0,0 +1 @@
+.. include:: ../CONTRIBUTING.rst