ruff seems like the best python linter out there which can potentially be used as an autoformatter as well.
If not, Black might be the best autoformatter that's similar to prettier.

Once a linter and autoformatter is added the workflowscript to test the api can be updated to this:

name: Python package

on: [push]

jobs:
  build:

    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]

    steps:
      - uses: actions/checkout@v3
      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v4
        with:
          python-version: ${{ matrix.python-version }}
      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          if [ -f api/requirements.txt ]; then pip install -r api/requirements.txt; fi
      - name: Lint with ruff
        run: |
          # stop the build if there are Python syntax errors or undefined names
          ruff --format=github --select=E9,F63,F7,F82 --target-version=py37 .
          # default set of ruff rules with GitHub Annotations
          ruff --format=github --target-version=py37 .
      - name: Test with pytest
        run: |
          pytest -v

Based on: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#using-the-python-starter-workflow

requirements.txt also needs to be updated with the linter and autoformatter that is chosen

https://github.com/Snailedlt/Markdown-Videos/actions/runs/5808366500/job/15744987441

I can see two approaches to fixing this:

1. Prevent the rate limiting from occurring in the first place.
2. Wait a few seconds and retry when we get rate limited.

The best solution would be to do both, though that might not be as easy as it sounds

We might be able to use deploy-to-deta (github repo)

Recommended by deta themselves: https://github.com/deta/awesome-deta#github-action

Add theme switcher to switch between themes.
Proposed themes:

• Dark
• Light
• System (Set the theme based on what the system's theme is)

Related to #136

Add an endpoint that takes a URL as input and returns a thumbnail.

Youtube URLs that should be accepted:
https://gist.github.com/rodrigoborgesdeoliveira/987683cfbfcc8d800192da1e73adc486

Vimeo URLs that should be accepted:
https://stackoverflow.com/questions/13286785/get-video-id-from-vimeo-url

See comments for implementations

Some info needed to implement python apps with turborepo: vercel/turbo#1077

• width (default=320)
• height (default=180)

Deta Cloud has been deprecated, and the repo needs to be migrated to Deta Space.
Migration guide: https://deta.space/migration/introduction/

I'm thinking it should contain the following:

• Links to:
  • GitHub Repo
  • GitHub Issues
  • Swagger docs
  • Redoc docs
• An input field where you can convert from a link into markdown
  • Validate that the URL is a valid http or https URL
  • Validate that the URL is for one of the supported platforms
  • Display error messages on API error responses
  • Highlight invalid fields
• A preview image of the thumbnail that links to the video
• A codeview that shows code in different languages
  • Markdown
  • HTML

Eventually I also want to add:

• Support for animated gif
• Expandable section with optional inputs
  • height
  • width
  • image type
  • gif?
    • length
• Theming
  • Dark Mode
  • Light Mode
  • System

website:
https://vimeo.com/watch

thumbnail:
https://vumbnail.com/{video_id}.jpg

After setting the width and height parameters to higher-than-default values, the image appears somewhat blurry. For example, even though my YouTube video has a maximum resolution of 1080p, when I set width and height to 960 and 540, respectively (https://markdown-videos.vercel.app/youtube/MtSMa02I1Co?width=960&height=540), the image is blurry:

I don't know if it's intentional or not. But there should be a way to make the image nonblurry. For example, https://img.youtube.com/vi/MtSMa02I1Co/maxresdefault.jpg would generate the maximum-resolution, nonblurry image.

As a side note (in addition to this blurry issue), perhaps you can consider grabbing the maximum-resolution width and height values from, for example, https://img.youtube.com/vi/{video_id}/maxresdefault.jpg, and use those values as the default values? And/or use the image from https://img.youtube.com/vi/{video_id}/maxresdefault.jpg and add the play button on top?

pipenv update
pnpm up --latest

Would be cool, but is it needed?
https://about.codecov.io/

I need a logo for the project! Do you wanna make it?

The logo should be related to both Markdown and Videos... Other than that I'm open to anything

For some reason pytest failed on python 11 here: https://github.com/Snailedlt/Markdown-Videos/actions/runs/5467320617
in this PR: #63

Not sure how or what to test. But at the very least we need some tests to make sure an image along with code is shown when a valid youtube video url and title is submitted.

related to #72

Should contain all the changes between each version, as well as the contributor who did the change.

If it's not too much work it would be nice to automate this too. Maybe we can just grab the version from the main package.json, and show a list of commits.

Examples

I really like these changelogs:

• svelte-preprocess's changelog
• npm's changelog
• svelte's changelog

What should the changelog include?

• Release version with link to release
• Release date
• A list of commits containing the following:
  • commit hash with link
  • commit message
  • link to pr

Example

v0.1.0 - August 9th, 2023

Commits

• 40d568f Minor documentation changes (#92)

  • Update urls in root README

  • update /apps/api README with new api url

  • Add .env documentation

  • Add vscode recommendation

  • Edit apps/web readme

  • Add deployment badge for both api and web

v0.2.0 - September 3rd, 2023

...

With the current config I get two PRs for every dependency update in the apps/web/ directory. This should be fixed

Create a script that updates the version of either the API or the website.
See #72 for where the version needs to be updated

The script should take the following arguments:

• app
  • Description: Which app do you want to update? /web or /api
  • Accepted arguments:
    • /
    • All subfolders of /apps. For example /web or /api
  • Note: If the app is from /apps the / root version will also be updated
• version-type
  • Description: Is it a major, minor or patch version?
  • Accepted values: major, minor, patch

Get img thumbnails from Vimeo?
https://stackoverflow.com/a/1361192/12206312

Parameters that should be parameterized include but are not limited to:

• filetype
• duration
• height
• width
• video_id

I guess what I need is a card with tabs. One tab for HTML, another for Markdown. Inside the tabs is title, the code, and a copy button.

Current implementation

Inspirations

https://highlightjs.org/

https://component-party.dev/#props

https://jimmyjames.github.io/justdocs/usage/code-blocks/

https://docs.readme.com/rdmd/docs/code-blocks#tabbed-code-blocks

https://www.w3schools.com/w3css/w3css_tabulators.asp

https://marketplace.atlassian.com/apps/1224338/confluence-code-block?tab=overview&hosting=cloud

https://stripe.com/docs/payments/accept-a-payment?platform=web&ui=checkout#redirect-customers

https://vercel.com/docs/cli#installing-vercel-cli

https://flowbite-svelte.com/docs/components/card#Set_up

The docs should be updated with info about response codes

https://markdown-videos.vercel.app/youtube/WHyOHQ_GkNo?width=100&height=100

Possible actions to use:

• https://github.com/actions/add-to-project

Youtube has a new url path parameter (?si) for tracking. This needs to be excluded when getting a thumbnail from the video id... so the regex needs to be updated. More info here: https://gist.github.com/rodrigoborgesdeoliveira/987683cfbfcc8d800192da1e73adc486?permalink_comment_id=4672606#gistcomment-4672606

Also, can we shorten the regex to this? (youtu.*be.*)\/(watch\?v=|embed\/|v|shorts|)(.*?((?=[&#?])|$)). Needs to be tested

Once the api is public, and version 1.0.0 has been released, we can add it to the example apps in the awesome-deta repo: https://github.com/deta/awesome-deta#apps--examples

Some basic error handling should be added

Optional parameters

Example with multiple parameters: https://markdown-videos.vercel.app/youtube/WHyOHQ_GkNo?width=320&height=180

Why?

Tests take a while to run. To make PR's faster tests should only run when relevant files are changed.
This depends on adding all relevant files into a single folder, which will be done as a part of #73

How?

https://stackoverflow.com/questions/63822219/how-to-run-github-actions-workflow-only-if-the-pushed-files-are-in-a-specific-fo

on:
  push:
    paths:
    - 'sub-project/**'

What?

The workflow fails with a linting error on the web package, however it works fine locally without any lint errors.

This happens every time the workflow runs... see for example this workflow run from #195

Notice the errors when running the svelte:check command. Those don't show up when running locally.

Why?

No idea

What have I tried?

1. Re-running the workflow
2. Updating the node version to the same as my local node version (19.9.0)
3. Removing the workflow cache from here: https://github.com/snailedlt/markdown-videos/actions/caches

Seems like GIF's aren't easily available via the Youtube API, so I'll need to use the thumbnail pictures and make a GIF myself.
Here are some resources:
Link to thumbnails: https://stackoverflow.com/a/64394638/12206312

Move the local development section from the README.md to the CONTRIBUTING.md file, and link to it in the README.

Decide what the project and domain name should be.

Suggestions:

I highlighted the ones I prefer

• videos-in-markdown
• video-to-markdown
• video-to-markdown-api
• video-markdown-embedder
• markdown-videos
• markdownvideos
• markdown-video-embedder
• video2md
• video2markdown
• mdvideos
• md-videos
• play-button-adder
• markdown-video-thumbnails
• video-thumbnail-api

Add workflow that checks if a the version has been updated in the following places:

• package.json
• apps/api/package.json
• apps/web/package.json
• apps/api/main.py

If the version in the PR is the same as the version on main it has not updated and the workflow should fail.

• app:api
• app:web
• devops/workflows

Prod

Localhost

Currently I'm using a local virtual environment + requirements.txt which is probably not the best solution.

Preferably it would be a similar to node + pnpm (or npm)

The workflow should have the following dependencies pre-installed:

• pnpm
• python
• pipenv

and run the following commands from the root directory:

pnpm install
pnpm api:install
pnpm build
pnpm test
pnpm lint

• /docs
• /redoc
• /info