Browse Source

Add PyPI release

pukkandan 4 years ago
parent
commit
7bc877a20d
4 changed files with 34 additions and 62 deletions
  1. 12 12
      .github/workflows/build.yml
  2. 0 33
      .github/workflows/python-publish.yml.disable
  3. 6 7
      README.md
  4. 16 10
      setup.py

+ 12 - 12
.github/workflows/build.yml

@@ -58,18 +58,18 @@ jobs:
       env:
         SHA2: ${{ hashFiles('youtube-dlc') }}
       run: echo "::set-output name=sha2_unix::$SHA2"
-    # - name: Install dependencies for pypi
-    #   run: |
-    #     python -m pip install --upgrade pip
-    #     pip install setuptools wheel twine
-    # - name: Build and publish
-    #   env:
-    #     TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
-    #     TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
-    #   run: |
-    #     rm -rf dist/*
-    #     python setup.py sdist bdist_wheel
-    #     twine upload dist/*
+    - name: Install dependencies for pypi
+      run: |
+        python -m pip install --upgrade pip
+        pip install setuptools wheel twine
+    - name: Build and publish on pypi
+      env:
+        TWINE_USERNAME: __token__
+        TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
+      run: |
+        rm -rf dist/*
+        python setup.py sdist bdist_wheel
+        twine upload dist/*
 
   build_windows:
 

+ 0 - 33
.github/workflows/python-publish.yml.disable

@@ -1,33 +0,0 @@
-# This workflows will upload a Python Package using Twine when a release is created
-# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
-
-name: Upload Python Package
-
-on:
-  push:
-    branches:
-      - release
-
-jobs:
-  deploy:
-
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Python
-      uses: actions/setup-python@v2
-      with:
-        python-version: '3.x'
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install setuptools wheel twine
-    - name: Build and publish
-      env:
-        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
-        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
-      run: |
-        rm -rf dist/*
-        python setup.py sdist bdist_wheel
-        twine upload dist/*

+ 6 - 7
README.md

@@ -75,15 +75,14 @@ If you are coming from [youtube-dl](https://github.com/ytdl-org/youtube-dl), the
 
 # INSTALLATION
 
-To use the latest version, simply download and run the [latest release](https://github.com/pukkandan/yt-dlp/releases/latest).
-Currently, there is no support for any package managers.
-
-If you want to install the current master branch
-
-    python -m pip install git+https://github.com/pukkandan/yt-dlp
+You can install yt-dlp using one of the following methods:
+* Use [PyPI package](https://pypi.org/project/yt-dlp/): `python -m pip install --upgrade yt-dlp`
+* Download the binary from the [latest release](https://github.com/pukkandan/yt-dlp/releases/latest)
+* Use pip+git: `python -m pip install --upgrade git+https://github.com/pukkandan/yt-dlp.git@release`
+* Install master branch: `python -m pip install --upgrade git+https://github.com/pukkandan/yt-dlp`
 
 ### UPDATE
-**DO NOT UPDATE using `-U` !** instead download binaries again
+`-U` does not work. Simply repeat the install process to update.
 
 ### COMPILE
 

+ 16 - 10
setup.py

@@ -11,8 +11,12 @@ from distutils.spawn import spawn
 exec(compile(open('youtube_dlc/version.py').read(),
              'youtube_dlc/version.py', 'exec'))
 
-DESCRIPTION = 'Media downloader supporting various sites such as youtube'
-LONG_DESCRIPTION = 'Command-line program to download videos from YouTube.com and other video sites. Based on a more active community fork.'
+DESCRIPTION = 'Command-line program to download videos from YouTube.com and many other other video platforms.'
+
+LONG_DESCRIPTION = '\n\n'.join((
+    'Official repository: <https://github.com/pukkandan/yt-dlp>',
+    '**PS**: Many links in this document will not work since this is a copy of the README.md from Github',
+    open("README.md", "r", encoding="utf-8").read()))
 
 if len(sys.argv) >= 2 and sys.argv[1] == 'py2exe':
     print("inv")
@@ -59,19 +63,21 @@ class build_lazy_extractors(Command):
         )
 
 setup(
-    name="youtube_dlc",
+    name="yt-dlp",
     version=__version__,
-    maintainer="Tom-Oliver Heidel",
-    maintainer_email="theidel@uni-bremen.de",
+    maintainer="pukkandan",
+    maintainer_email="pukkandan@gmail.com",
     description=DESCRIPTION,
     long_description=LONG_DESCRIPTION,
-    # long_description_content_type="text/markdown",
+    long_description_content_type="text/markdown",
     url="https://github.com/pukkandan/yt-dlp",
     packages=find_packages(exclude=("youtube_dl","test",)),
-	#packages=[
-    #    'youtube_dlc',
-    #    'youtube_dlc.extractor', 'youtube_dlc.downloader',
-    #    'youtube_dlc.postprocessor'],
+    project_urls={
+        'Documentation': 'https://github.com/pukkandan/yt-dlp#yt-dlp',
+        'Source': 'https://github.com/pukkandan/yt-dlp',
+        'Tracker': 'https://github.com/pukkandan/yt-dlp/issues',
+        #'Funding': 'https://donate.pypi.org',
+    },
     classifiers=[
 	    "Topic :: Multimedia :: Video",
         "Development Status :: 5 - Production/Stable",