Skip to content

Commit

Permalink
Add extras_require section to setup and update README
Browse files Browse the repository at this point in the history
  • Loading branch information
kenjyco committed Apr 13, 2022
1 parent 7bfeb79 commit f4e8c66
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 23 deletions.
16 changes: 5 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ or
% brew install moc
```

If you don't have [docker](https://docs.docker.com/get-docker) installed,
If you **don't have [docker](https://docs.docker.com/get-docker) installed**,
install Redis and start server

```
Expand All @@ -33,22 +33,16 @@ Install with `pip`
### yt-helper

A lot of what powers the cool interactive features are provided by the
`COMMENTS` and `FILES` collections defined in `yt_helper`.
`COMMENTS` and `FILES` `redis_helper.Collections` defined in `yt_helper`.

Install system av tools
Install with `pip`

```
% sudo apt-get install -y libav-tools sox rtmpdump
% pip3 install yt-helper
or
% brew install libav sox rtmpdump
```

Install with `pip`

```
% pip3 install yt-helper
% pip3 install "mocp-cli[extras]"
```

## Usage
Expand Down
20 changes: 8 additions & 12 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,9 @@ Install the actual `MOC player/server <https://moc.daper.net/>`__

% brew install moc

If you don’t have `docker <https://docs.docker.com/get-docker>`__
installed, install Redis and start server
If you **don’t
have**\ `docker <https://docs.docker.com/get-docker>`__\ **installed**,
install Redis and start server

::

Expand All @@ -36,23 +37,18 @@ yt-helper
~~~~~~~~~

A lot of what powers the cool interactive features are provided by the
``COMMENTS`` and ``FILES`` collections defined in ``yt_helper``.
``COMMENTS`` and ``FILES`` ``redis_helper.Collections`` defined in
``yt_helper``.

Install system av tools
Install with ``pip``

::

% sudo apt-get install -y libav-tools sox rtmpdump
% pip3 install yt-helper

or

% brew install libav sox rtmpdump

Install with ``pip``

::

% pip3 install yt-helper
% pip3 install "mocp-cli[extras]"

Usage
-----
Expand Down
1 change: 1 addition & 0 deletions requirements-extras.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
mocp[extras]
6 changes: 6 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@
with open('requirements.txt', 'r') as fp:
requirements = fp.read().splitlines()

with open('requirements-extras.txt', 'r') as fp:
requirements_extras = fp.read().splitlines()

setup(
name='mocp-cli',
version='0.1.19',
Expand All @@ -19,6 +22,9 @@
download_url='https://github.com/kenjyco/mocp-cli/tarball/v0.1.19',
packages=find_packages(),
install_requires=requirements,
extras_require={
'extras': requirements_extras,
},
include_package_data=True,
package_dir={'': '.'},
package_data={
Expand Down

0 comments on commit f4e8c66

Please sign in to comment.