Add license and readme for publishing
This commit is contained in:
parent
a031f90765
commit
f238b656fc
|
@ -0,0 +1,29 @@
|
||||||
|
BSD 3-Clause License
|
||||||
|
|
||||||
|
Copyright (c) 2021, Pavle Portic <git@theedgeofrage.com>
|
||||||
|
All rights reserved.
|
||||||
|
|
||||||
|
Redistribution and use in source and binary forms, with or without
|
||||||
|
modification, are permitted provided that the following conditions are met:
|
||||||
|
|
||||||
|
* Redistributions of source code must retain the above copyright notice, this
|
||||||
|
list of conditions and the following disclaimer.
|
||||||
|
|
||||||
|
* Redistributions in binary form must reproduce the above copyright notice,
|
||||||
|
this list of conditions and the following disclaimer in the documentation
|
||||||
|
and/or other materials provided with the distribution.
|
||||||
|
|
||||||
|
* Neither the name of the copyright holder nor the names of its
|
||||||
|
contributors may be used to endorse or promote products derived from
|
||||||
|
this software without specific prior written permission.
|
||||||
|
|
||||||
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||||||
|
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||||
|
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||||
|
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
||||||
|
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||||
|
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
||||||
|
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
||||||
|
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
||||||
|
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||||
|
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
@ -0,0 +1,11 @@
|
||||||
|
# YouTube RSS manager
|
||||||
|
|
||||||
|
This is a simple CLI to manage YouTube subscriptions through RSS feeds
|
||||||
|
and watch new videos using `mpv`. It keeps track of watched videos in a local
|
||||||
|
sqlite database.
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
It looks for a list of RSS URLs in `$XDG_CONFIG_HOME/ytrssil/feeds`
|
||||||
|
(~/.config/ by default), with one URL per line. Only YouTube channel feeds
|
||||||
|
are supported at this moment.
|
17
setup.py
17
setup.py
|
@ -1,15 +1,23 @@
|
||||||
from setuptools import setup # type: ignore
|
from setuptools import setup # type: ignore
|
||||||
|
|
||||||
|
|
||||||
with open('requirements.txt') as f:
|
with open('readme.md', 'r') as f:
|
||||||
|
long_description = f.read()
|
||||||
|
|
||||||
|
with open('requirements.txt', 'r') as f:
|
||||||
required = f.read().splitlines()
|
required = f.read().splitlines()
|
||||||
|
|
||||||
|
|
||||||
setup(
|
setup(
|
||||||
name='ytrssil',
|
name='ytrssil',
|
||||||
|
author='Pavle Portic',
|
||||||
|
author_email='git@theedgeofrage.com',
|
||||||
description=(
|
description=(
|
||||||
'Subscribe to YouTube RSS feeds and keep track of watched videos'
|
'Subscribe to YouTube RSS feeds and keep track of watched videos'
|
||||||
),
|
),
|
||||||
|
long_description=long_description,
|
||||||
|
long_description_content_type='text/markdown',
|
||||||
|
license='BSD-3-Clause',
|
||||||
homepage='https://gitea.theedgeofrage.com/TheEdgeOfRage/ytrssil',
|
homepage='https://gitea.theedgeofrage.com/TheEdgeOfRage/ytrssil',
|
||||||
repository='https://gitea.theedgeofrage.com/TheEdgeOfRage/ytrssil',
|
repository='https://gitea.theedgeofrage.com/TheEdgeOfRage/ytrssil',
|
||||||
documentation='https://gitea.theedgeofrage.com/TheEdgeOfRage/ytrssil',
|
documentation='https://gitea.theedgeofrage.com/TheEdgeOfRage/ytrssil',
|
||||||
|
@ -23,4 +31,11 @@ setup(
|
||||||
'ytrssil = ytrssil.cli:main',
|
'ytrssil = ytrssil.cli:main',
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
|
classifiers=[
|
||||||
|
'Programming Language :: Python :: 3',
|
||||||
|
'Programming Language :: Python :: 3 :: Only',
|
||||||
|
'Programming Language :: Python :: 3.9',
|
||||||
|
'License :: OSI Approved :: BSD License',
|
||||||
|
'Operating System :: POSIX :: Linux',
|
||||||
|
],
|
||||||
)
|
)
|
||||||
|
|
Loading…
Reference in New Issue