From 7c2021aef961603db93b5da0ab4135398b85e583 Mon Sep 17 00:00:00 2001 From: Matthias Geier Date: Tue, 22 Sep 2015 15:14:04 +0200 Subject: [PATCH] Release 0.1.0 --- .gitignore | 2 +- LICENSE | 2 +- MANIFEST.in | 8 ++++++++ README.rst | 21 ++++++++++++++++++--- setup.py | 4 ++-- sfs/_version.py | 2 +- 6 files changed, 31 insertions(+), 8 deletions(-) create mode 100644 MANIFEST.in diff --git a/.gitignore b/.gitignore index 8b3a6d7..e1b18df 100644 --- a/.gitignore +++ b/.gitignore @@ -3,4 +3,4 @@ __pycache__/ build/ dist/ .eggs/ -SoundFieldSynthesis.egg-info/ +sfs.egg-info/ diff --git a/LICENSE b/LICENSE index fe72dc4..36e39e0 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,4 @@ -Copyright (c) 2014 SFS Toolbox Developers +Copyright (c) 2014-2015 SFS Toolbox Developers Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..4412450 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,8 @@ +include LICENSE +include *.rst +include doc/requirements.txt +recursive-include doc *.rst *.py +recursive-include tests *.py +recursive-include examples *.py +include examples/figures/*.png +recursive-include data * diff --git a/README.rst b/README.rst index a559f0e..ca49c5f 100644 --- a/README.rst +++ b/README.rst @@ -11,6 +11,9 @@ Documentation: Code: http://github.com/sfstoolbox/sfs-python/ +Python Package Index: + http://pypi.python.org/pypi/sfs/ + Requirements ------------ @@ -31,14 +34,26 @@ distribution that already includes everything, e.g. Anaconda_. Installation ------------ -Currently, the package is not yet available on PyPI_ (but coming soon!), for -now you should get it from Github_:: +Once you have installed the above-mentioned dependencies, you can use pip_ +to download and install the latest release with a single command:: + + pip install sfs --user + +If you want to install it system-wide for all users (assuming you have the +necessary rights), you can just drop the ``--user`` option. + +To un-install, use:: + + pip uninstall sfs + +If you want to keep up with the latest and greatest development version you +should get it from Github_:: git clone https://github.com/sfstoolbox/sfs-python.git cd sfs-python python setup.py develop --user -.. _PyPI: http://pypi.python.org/ +.. _pip: http://www.pip-installer.org/en/latest/installing.html .. _Github: http://github.com/sfstoolbox/sfs-python/ How to Get Started diff --git a/setup.py b/setup.py index e2770d2..73e3bff 100644 --- a/setup.py +++ b/setup.py @@ -26,7 +26,7 @@ def run_tests(self): exec(open('sfs/_version.py').read()) # "import" __version__ setup( - name="SoundFieldSynthesis", + name="sfs", version=__version__, packages=['sfs'], install_requires=[ @@ -40,7 +40,7 @@ def run_tests(self): long_description=open('README.rst').read(), license="MIT", keywords="audio SFS WFS Ambisonics".split(), - url="http://github.com/sfstoolbox", + url="http://github.com/sfstoolbox/", platforms='any', classifiers=[ "Development Status :: 3 - Alpha", diff --git a/sfs/_version.py b/sfs/_version.py index 988d382..93b9d55 100644 --- a/sfs/_version.py +++ b/sfs/_version.py @@ -9,4 +9,4 @@ """ -__version__ = "0.0.0" +__version__ = "0.1.0"