play football match highlights
==============================
..
GitHub Actions
~~~~~~~~~~~~~~
You can find all the configuration files of GitHub Actions in ``.github/workflows`` folder.
Content
:::::::
+-------------+----------------------------------------------+--------------------------------------------------+-----------------------------+-----------------------------------------------------------+
| Config File | Steps | Trigger Rules | Requisite CI/CD Variables | CI/CD Variables description |
+=============+==============================================+==================================================+=============================+===========================================================+
| | mypy check | | | |
| +----------------------------------------------+ | | |
| | flake8 check | + **Pushes** to *master/develop* branches | | |
| +----------------------------------------------+ | | |
| test.yml | bandit check | + **Pull Requests** to *master/develop* branches | | |
| +----------------------------------------------+ | | |
| | test with python 3.8 (Ubuntu/Mac OS/Windows) | | | |
| +----------------------------------------------+ | | |
| | test with python 3.9 (Ubuntu/Mac OS/Windows) | | | |
| +----------------------------------------------+ | | |
| | test with python 3.10 (Ubuntu/Mac OS/Windows)| | | |
| +----------------------------------------------+ | | |
| | test with python 3.11 (Ubuntu/Mac OS/Windows)| | | |
| +----------------------------------------------+ | | |
| | test with python 3.12 (Ubuntu/Mac OS/Windows)| | | |
| +----------------------------------------------+ | | |
| | twine check the built package | | | |
+-------------+----------------------------------------------+--------------------------------------------------+-----------------------------+-----------------------------------------------------------+
| | | | | Token for uploading package to official PyPi. If you're |
| | | | POETRY_PYPI_TOKEN_PYPI | using a private artifactory, please use the variables |
| | | | | `PACKAGE_INDEX_REPOSITORY_URL`, `PACKAGE_INDEX_USERNAME`, |
| | | | | and `PACKAGE_INDEX_PASSWORD` instead. |
| | | +-----------------------------+-----------------------------------------------------------+
| | | | PACKAGE_INDEX_REPOSITORY_URL| URL of Private package index. |
| release.yml | deploy to PyPi | **Pushes** to tags matching *vXX.XX.XX* +-----------------------------+-----------------------------------------------------------+
| | | | PACKAGE_INDEX_USERNAME | Username of Private package index. |
| | | +-----------------------------+-----------------------------------------------------------+
| | | | PACKAGE_INDEX_PASSWORD | Password of Private package index. |
+-------------+----------------------------------------------+--------------------------------------------------+-----------------------------+-----------------------------------------------------------+
| sphinx.yml | deploy GitHub pages | **Pushes** to *master* branch | | |
+-------------+----------------------------------------------+--------------------------------------------------+-----------------------------+-----------------------------------------------------------+
**Note**:
+ Before publishing the GitHub pages of your project for the first time, please manually create the branch **gh-pages** via::
$ git checkout master
$ git checkout -b gh-pages
$ git push origin gh-pages
Setup Steps
:::::::::::
1. Go to **Settings**.
2. Click **Secrets** section.
3. Click **New repository secret** button.
4. Input the name and value of a CI/CD variable.
Makefile
++++++++
.. list-table::
:header-rows: 1
* - Command
- Description
* - clean
- Remove autogenerated folders and artifacts.
* - clean-pyc
- Remove python artifacts.
* - clean-build
- Remove build artifacts.
* - bandit
- Run `bandit`_ security analysis.
* - mypy
- Run `mypy`_ type checking.
* - flake8
- Run `flake8`_ linting.
* - install
- Install all the dependencies and the package itself.
* - test
- Run tests and generate coverage report.
* - build
- Build wheel package.
* - publish
- Publish the built wheel package.
Introduction
------------
Play football match highlights without ads.
User Guide
----------
Requirements
++++++++++++
Optionally this toll uses Chrome browser and the Chrome Extension [Native HLS Playback](https://chromewebstore.google.com/detail/native-hls-playback/emnphkkblegpebimobpbekeedfgemhof?pli=1)
for playing the extracted m3u8 play list. If you want to use this feature, please install Chrome browser
and its extension [Native HLS Playback](https://chromewebstore.google.com/detail/native-hls-playback/emnphkkblegpebimobpbekeedfgemhof?pli=1) firstly.
How to Install
++++++++++++++
Stable release
``````````````
To install play football match highlights, run this command in your terminal:
.. code-block:: console
$ pip install play_football_match_highlights
or
.. code-block:: console
$ poetry self add play_football_match_highlights
This is the preferred method to install play football match highlights, as it will always install the most recent stable release.
From sources
````````````
The sources for play football match highlights can be downloaded from the `Github repo <https://github.com/zhiwei2017/play-football-match-highlights>`_.
You can either clone the public repository:
.. code-block:: console
$ git clone https://github.com/zhiwei2017/play-football-match-highlights.git
Once you have a copy of the source, you can install it with:
.. code-block:: console
$ pip install .
or
.. code-block:: console
$ poetry install
How to Use
++++++++++
To use play football match highlights in Chrome::
$ play_match_highlights --with-chrome
To use it just for getting the url for the football match highlight, please use::
$ play_match_highlights
Maintainers
-----------
..
TODO: List here the people responsible for the development and maintaining of this project.
Format: **Name** - *Role/Responsibility* - Email
* **Zhiwei Zhang** - *Maintainer* - `zhiwei2017@gmail.com <mailto:zhiwei2017@gmail.com?subject=[GitHub]play%20football%20match%20highlights>`_
Raw data
{
"_id": null,
"home_page": "https://github.com/zhiwei2017/play-football-match-highlights",
"name": "play-football-match-highlights",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": null,
"author": "Zhiwei Zhang",
"author_email": "zhiwei2017@gmail.com",
"download_url": null,
"platform": null,
"description": "play football match highlights\n==============================\n\n..\n GitHub Actions\n ~~~~~~~~~~~~~~\n\n You can find all the configuration files of GitHub Actions in ``.github/workflows`` folder.\n\n Content\n :::::::\n\n +-------------+----------------------------------------------+--------------------------------------------------+-----------------------------+-----------------------------------------------------------+\n | Config File | Steps | Trigger Rules | Requisite CI/CD Variables | CI/CD Variables description |\n +=============+==============================================+==================================================+=============================+===========================================================+\n | | mypy check | | | |\n | +----------------------------------------------+ | | |\n | | flake8 check | + **Pushes** to *master/develop* branches | | |\n | +----------------------------------------------+ | | |\n | test.yml | bandit check | + **Pull Requests** to *master/develop* branches | | |\n | +----------------------------------------------+ | | |\n | | test with python 3.8 (Ubuntu/Mac OS/Windows) | | | |\n | +----------------------------------------------+ | | |\n | | test with python 3.9 (Ubuntu/Mac OS/Windows) | | | |\n | +----------------------------------------------+ | | |\n | | test with python 3.10 (Ubuntu/Mac OS/Windows)| | | |\n | +----------------------------------------------+ | | |\n | | test with python 3.11 (Ubuntu/Mac OS/Windows)| | | |\n | +----------------------------------------------+ | | |\n | | test with python 3.12 (Ubuntu/Mac OS/Windows)| | | |\n | +----------------------------------------------+ | | |\n | | twine check the built package | | | |\n +-------------+----------------------------------------------+--------------------------------------------------+-----------------------------+-----------------------------------------------------------+\n | | | | | Token for uploading package to official PyPi. If you're |\n | | | | POETRY_PYPI_TOKEN_PYPI | using a private artifactory, please use the variables |\n | | | | | `PACKAGE_INDEX_REPOSITORY_URL`, `PACKAGE_INDEX_USERNAME`, |\n | | | | | and `PACKAGE_INDEX_PASSWORD` instead. |\n | | | +-----------------------------+-----------------------------------------------------------+\n | | | | PACKAGE_INDEX_REPOSITORY_URL| URL of Private package index. |\n | release.yml | deploy to PyPi | **Pushes** to tags matching *vXX.XX.XX* +-----------------------------+-----------------------------------------------------------+\n | | | | PACKAGE_INDEX_USERNAME | Username of Private package index. |\n | | | +-----------------------------+-----------------------------------------------------------+\n | | | | PACKAGE_INDEX_PASSWORD | Password of Private package index. |\n +-------------+----------------------------------------------+--------------------------------------------------+-----------------------------+-----------------------------------------------------------+\n | sphinx.yml | deploy GitHub pages | **Pushes** to *master* branch | | |\n +-------------+----------------------------------------------+--------------------------------------------------+-----------------------------+-----------------------------------------------------------+\n\n **Note**:\n\n + Before publishing the GitHub pages of your project for the first time, please manually create the branch **gh-pages** via::\n\n $ git checkout master\n $ git checkout -b gh-pages\n $ git push origin gh-pages\n\n Setup Steps\n :::::::::::\n\n 1. Go to **Settings**.\n 2. Click **Secrets** section.\n 3. Click **New repository secret** button.\n 4. Input the name and value of a CI/CD variable.\n\n \n Makefile\n ++++++++\n\n .. list-table::\n :header-rows: 1\n\n * - Command\n - Description\n * - clean\n - Remove autogenerated folders and artifacts.\n * - clean-pyc\n - Remove python artifacts.\n * - clean-build\n - Remove build artifacts.\n * - bandit\n - Run `bandit`_ security analysis.\n * - mypy\n - Run `mypy`_ type checking.\n * - flake8\n - Run `flake8`_ linting.\n * - install\n - Install all the dependencies and the package itself.\n * - test\n - Run tests and generate coverage report.\n * - build\n - Build wheel package.\n * - publish\n - Publish the built wheel package.\n\nIntroduction\n------------\nPlay football match highlights without ads.\n\nUser Guide\n----------\n\nRequirements\n++++++++++++\n\nOptionally this toll uses Chrome browser and the Chrome Extension [Native HLS Playback](https://chromewebstore.google.com/detail/native-hls-playback/emnphkkblegpebimobpbekeedfgemhof?pli=1)\nfor playing the extracted m3u8 play list. If you want to use this feature, please install Chrome browser\nand its extension [Native HLS Playback](https://chromewebstore.google.com/detail/native-hls-playback/emnphkkblegpebimobpbekeedfgemhof?pli=1) firstly.\n\nHow to Install\n++++++++++++++\n\nStable release\n``````````````\n\nTo install play football match highlights, run this command in your terminal:\n\n.. code-block:: console\n\n $ pip install play_football_match_highlights\n\nor\n\n.. code-block:: console\n\n $ poetry self add play_football_match_highlights\n\nThis is the preferred method to install play football match highlights, as it will always install the most recent stable release.\n\n\nFrom sources\n````````````\n\nThe sources for play football match highlights can be downloaded from the `Github repo <https://github.com/zhiwei2017/play-football-match-highlights>`_.\n\nYou can either clone the public repository:\n\n.. code-block:: console\n\n $ git clone https://github.com/zhiwei2017/play-football-match-highlights.git\n\nOnce you have a copy of the source, you can install it with:\n\n.. code-block:: console\n\n $ pip install .\n\nor\n\n.. code-block:: console\n\n $ poetry install\n\nHow to Use\n++++++++++\n\nTo use play football match highlights in Chrome::\n\n $ play_match_highlights --with-chrome\n\nTo use it just for getting the url for the football match highlight, please use::\n\n $ play_match_highlights\n\nMaintainers\n-----------\n\n..\n TODO: List here the people responsible for the development and maintaining of this project.\n Format: **Name** - *Role/Responsibility* - Email\n\n* **Zhiwei Zhang** - *Maintainer* - `zhiwei2017@gmail.com <mailto:zhiwei2017@gmail.com?subject=[GitHub]play%20football%20match%20highlights>`_\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Play football match highlights without ads.",
"version": "0.1.0",
"project_urls": {
"Documentation": "https://github.com/zhiwei2017/play-football-match-highlights",
"Homepage": "https://github.com/zhiwei2017/play-football-match-highlights",
"Repository": "https://github.com/zhiwei2017/play-football-match-highlights"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "337b9ee384bb3a15ad01a512cd508b0f8ea3b1db4ddaa8471d04ef8a054c5533",
"md5": "ba2220f7d603c8d1acb755f2285790bf",
"sha256": "282732a2132509facc09d3587f92dac1d1bddd2bfde23cc270e32a305b3a531d"
},
"downloads": -1,
"filename": "play_football_match_highlights-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ba2220f7d603c8d1acb755f2285790bf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 5884,
"upload_time": "2024-10-21T14:58:09",
"upload_time_iso_8601": "2024-10-21T14:58:09.819845Z",
"url": "https://files.pythonhosted.org/packages/33/7b/9ee384bb3a15ad01a512cd508b0f8ea3b1db4ddaa8471d04ef8a054c5533/play_football_match_highlights-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-21 14:58:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "zhiwei2017",
"github_project": "play-football-match-highlights",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "play-football-match-highlights"
}
JSON
