Add packaging configs

akiomik · Jan 23, 2020 · 08a2fcd · 08a2fcd
1 parent ab876a2
commit 08a2fcd
Show file tree

Hide file tree

Showing 7 changed files with 288 additions and 206 deletions.
diff --git a/Pipfile b/Pipfile
@@ -7,7 +7,15 @@ verify_ssl = true
 precountify = {editable = true,extras = ["madmom"],path = "."}
 pytest = "*"
 flake8 = "*"
+twine = "*"
+wheel = "*"
 
 [packages]
-fire = "*"
-librosa = "*"
+
+[scripts]
+test = "pytest"
+lint = "flake8 precountify tests"
+build = "python setup.py sdist bdist_wheel"
+clean = "rm -rf build dist precountify.egg-info"
+test-upload = "twine upload -s -r test dist/*"
+upload = "twine upload -s -r pypi dist/*"
diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/README.md b/README.md
@@ -3,6 +3,22 @@
 
 A tool for adding pre-count (count-off) click to audio file.
 
+## Requirements
+
+- python >= 3.4
+
+## Install
+
+```sh
+pip install precountify
+
+# with madmom
+pip install precountify[madmom]
+
+# with essentia (linux only)
+pip install precountify[essentia]
+```
+
 ## Usage
 
 ```sh

diff --git a/precountify/audio/__init__.py b/precountify/audio/__init__.py
diff --git a/precountify/estimator/__init__.py b/precountify/estimator/__init__.py
diff --git a/setup.cfg b/setup.cfg
@@ -7,6 +7,7 @@ description = A tool for pre-countifying
 long_description = file: README.md
 long_description_content_type = text/markdown
 keywords =
+  audio-processing
 url = https://github.com/akiomik/precountify
 license = Apache License 2.0
 license_file = LICENSE
@@ -29,6 +30,8 @@ classifiers =
 [options]
 zip_safe = false
 packages = find:
+setup_requires =
+  setuptools >= 38.3.0
 python_requires = >=3.4
 
 [options.extras_require]
@@ -39,6 +42,9 @@ essentia = essentia==2.1b5
 exclude =
     *.tests
 
+[options.package_data]
+* = data/*.wav
+
 [options.entry_points]
 console_scripts =
   precountify = precountify.cli:main

diff --git a/setup.py b/setup.py
@@ -1,4 +1,4 @@
 from setuptools import setup
 setup(
-    install_requires=[]
+    install_requires=['fire', 'librosa']
 )