Updates the readme as well as a few config files.

This commit is contained in:
Markil3
2021-08-14 14:58:44 -06:00
parent ff13c5a575
commit 2d13980d98
4 changed files with 23 additions and 11 deletions

View File

@@ -12,6 +12,7 @@ install_repeat: play_repeat
install_lollypop: lollypopint
pip install dist/*.whl
cp play ~/.local/bin/play_capture
play_capture: capture.c
$(CC) -o play_capture capture.c
@@ -22,6 +23,9 @@ play_repeat: repeat.c
lollypopint: setup.py lollypopint/__init__.py
python setup.py bdist_wheel
upload: lollypopint
python -m twine upload dist/*
clean:
rm -f play_capture play_repeat
rm -fr build

View File

@@ -1,17 +1,15 @@
# commandlinePlay
Uses VLC media player and a music database to search for and play music from the linux command line.
# Lollypop Interface
This application works in extension to the Lollypop Music Player to allow users to search for and play songs from a command-line interface.
It works in two parts. The first one, the play python module, does most of the work. It accepts a series of search terms and then looks through a compatible SQLite3 database (the Lollypop music player database, by default) for the songs before launching VLC media player.
The second part, the key listener, will listen for arguments for the python module from the keyboard without changing window focus, with audio feedback to ensure that the user knows that they are inputing into the program. This part will need to be run by a user added to the `input` user group.
## Building
## Building and Installing
The listener can be built with the following command
```
gcc capture.c -o play_capture
```
The Python module does not require any external dependencies as far as execution goes.
Running `make` will build the play_capture and play_repeat utilities. The
To install, run `make install`. This will install the utilities to $HOME/.local/bin and the python module to the standard installation directories via pip. For convenience, a "play" utility is installed to the user bin directory for running the python module.
## Song Database

4
play Executable file
View File

@@ -0,0 +1,4 @@
#!/usr/bin/env python
from lollypopint import __main__
__main__()

View File

@@ -1,11 +1,17 @@
import os
from setuptools import find_packages, setuptools, setup
def read(fname):
return open(os.path.join(os.path.dirname(__file__), fname)).read()
setup(
name='lollypopint-markil3',
name='lollypopint',
packages=find_packages(include=['lollypopint']),
version='0.1.0',
description='An extension of the Lollypop Music Player that lets you search for and play music files from the command line',
long_description='file: README.md'
long_description=read('README.md'),
long_description_content_type='text/markdown',
author='Markil3',
license='gpl-3.0'
license='gpl-3.0',
url='https://github.com/Markil3/LollypopInt'
)