Skip to content

Commit

Permalink
📝 🔖 Add code for upload to PyPi and update documentation (#5)
Browse files Browse the repository at this point in the history
* 📝 change documentation for PyPi 🔖 add code for pypi

* 📝 install on its own line

* 📝 add bash code snippet.
  • Loading branch information
rlenain authored May 22, 2020
1 parent 10bce3f commit 376d5ec
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 2 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,12 @@ Our documentation can be found [here](https://surfboard.readthedocs.io/en/latest

## :surfer: Installation :surfer:

Install using pip
```bash
pip install surfboard
```

Alternatively,
* Clone the repo: `git clone https://github.com/novoic/surfboard.git`
* Navigate into the repo: `cd surfboard`
* Install the repo: `pip3 install .`
Expand Down
8 changes: 7 additions & 1 deletion docs/installation.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,13 @@
Installing Surfboard
====================

Installing Surfboard is as easy as boogie boarding!
Installing Surfboard is as easy as boogie boarding! You can install it from PyPi:

.. code::
pip install surfboard
Alternatively, you can clone it and install it as such:

.. code::
Expand Down
2 changes: 2 additions & 0 deletions setup.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[metadata]
description-file = README.md
26 changes: 25 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,25 @@
setup(
name="surfboard",
version="0.1",
description="The Novoic acoustic feature extraction package.",
description="Novoic's audio feature extraction library https://novoic.com",
url="http://github.com/novoic/surfboard",
author="Raphael Lenain",
author_email="[email protected]",
license="GPL-3.0",
packages=["surfboard"],
keywords=[
"feature-extraction",
"audio",
"machine-learning",
"audio-processing",
"python",
"speech-processing",
"healthcare",
"signal-processing",
"alzheimers-disease",
"parkinsons-disease",
],
download_url="https://github.com/novoic/surfboard/archive/v0.1.tar.gz",
install_requires=[
"librosa==0.7.2",
"pysptk==0.1.18",
Expand All @@ -23,4 +36,15 @@
],
scripts=['bin/surfboard'],
zip_safe=False,
classifiers=[
'Development Status :: 4 - Beta', # Chose either "3 - Alpha", "4 - Beta" or "5 - Production/Stable" as the current state of your package
'Intended Audience :: Developers', # Define that your audience are developers
'Topic :: Software Development :: Build Tools',
'License :: OSI Approved :: GNU General Public License v3 (GPLv3)', # Again, pick a license
'Programming Language :: Python :: 3', #Specify which pyhton versions that you want to support
'Programming Language :: Python :: 3.4',
'Programming Language :: Python :: 3.5',
'Programming Language :: Python :: 3.6',
'Programming Language :: Python :: 3.7',
],
)

0 comments on commit 376d5ec

Please sign in to comment.