v1.0.0: version bump

Some major backward incompatible changes have been made to the API. Please refer the new `docs/usage.rst`
for checking in what changes in the API

Author: prodicus

README.rst

@@ -253,7 +253,7 @@ Built with ♥ by `Tasdik Rahman <http://tasdikrahman.me/>`__ under the `MIT Lic
 You can find a copy of the License at http://prodicus.mit-license.org/
 
 .. |PyPI version| image:: https://img.shields.io/pypi/v/Vocabulary.svg
-   :target: https://pypi.python.org/pypi/Vocabulary/0.0.6
+   :target: https://pypi.python.org/pypi/Vocabulary/1.0.0
 .. |License| image:: https://img.shields.io/pypi/l/vocabulary.svg
    :target: https://github.com/prodicus/vocabulary/blob/master/LICENSE
 .. |Python Versions| image:: https://img.shields.io/pypi/pyversions/Vocabulary.svg

docs/conf.py

@@ -17,6 +17,19 @@
 import os
 import shlex
 
+sys.path.insert(0, os.path.abspath('..'))
+
+from vocabulary.version import VERSION, RELEASE
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.''
+version = VERSION
+# The full version, including alpha/beta/rc tags.
+release = RELEASE
+
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
@@ -57,14 +70,7 @@
 copyright = '2015, Tasdik Rahman'
 author = 'Tasdik Rahman'
 
-# The version info for the project you're documenting, acts as replacement for
-# |version| and |release|, also used in various other places throughout the
-# built documents.
-#
-# The short X.Y version.
-version = '0.0.6'
-# The full version, including alpha/beta/rc tags.
-release = '5'
+
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/contributing.rst

@@ -54,7 +54,6 @@ To do
 Tests
 =====
 
-``Vocabulary`` uses ``unittesting`` for testing purposes.
 
 Running the test cases
 
@@ -87,7 +86,16 @@ Discuss
 Join us on our `Gitter channel <https://gitter.im/prodicus/vocabulary>`__
 if you want to chat or if you have any questions.
 
-Contributers
+Building the docs
+=================
+
+Install the `Sphinx` by doing a `$ pip install requirements-dev.txt`
+
+.. code-block:: bash
+
+    $ make html
+
+Contributors
 ============
 
 -  Thanks to `Anton Relin <https://github.com/relisher>`__ for adding the `translate()` module

requirements-dev.txt

@@ -0,0 +1 @@
+Sphinx==1.5.5

setup.py

@@ -2,11 +2,24 @@
 # -*- coding: utf-8 -*-
 
 import sys
+
 try:
-  import os
-  from setuptools import setup, find_packages
+    from os import path
+    from setuptools import setup, find_packages
 except ImportError:
-  from distutils.core import setup
+    from distutils.core import setup
+
+from vocabulary.version import VERSION
+__version__ = VERSION
+
+here = path.abspath(path.dirname(__file__))
+
+# get the dependencies and installs
+with open(path.join(here, 'requirements.txt'), encoding='utf-8') as f:
+    all_reqs = f.read().split('\n')
+
+install_requires = [x.strip() for x in all_reqs if 'git+' not in x]
+dependency_links = [x.strip().replace('git+', '') for x in all_reqs if 'git+' not in x]
 
 try:
     if sys.version_info[:2] <= (2, 7):
@@ -18,29 +31,27 @@
     readme.close()
 
 setup(
-  name = 'Vocabulary',
-  version = '0.0.6',
-  author = 'Tasdik Rahman',
-  author_email = 'tasdik95@gmail.com',
-  description = "Module to get meaning, synonym, antonym, part_of_speech, usage_example, pronunciation and hyphenation for a given word",
-  long_description=long_description,
-  url = 'https://github.com/prodicus/vocabulary',
-  license = 'MIT',
-  install_requires = [
-    "requests==2.13.0",
-  ],
-  ### adding package data to it
-  packages=find_packages(exclude=['contrib', 'docs']),
-  ###
-  download_url = 'https://github.com/prodicus/vocabulary/tarball/0.0.6',
-  classifiers = [
-      'Intended Audience :: Developers',
-      'License :: OSI Approved :: MIT License',
-      'Natural Language :: English',
-      'Programming Language :: Python',
-      'Programming Language :: Python :: 2.7',
-      'Programming Language :: Python :: 3',
-      'Programming Language :: Python :: 3.4',
-  ],
-  keywords = ['Dictionary', 'Vocabulary', 'simple dictionary','pydict', 'dictionary module']
+    name='Vocabulary',
+    author='Tasdik Rahman',
+    version=VERSION,
+    author_email='tasdik95@gmail.com',
+    description="Module to get meaning, synonym, antonym, part_of_speech, usage_example, pronunciation and hyphenation for a given word",
+    long_description=long_description,
+    url='https://github.com/prodicus/vocabulary',
+    license='MIT',
+    install_requires=install_requires,
+    dependency_links=dependency_links,
+    # adding package data to it
+    packages=find_packages(exclude=['contrib', 'docs']),
+    download_url='https://github.com/prodicus/vocabulary/tarball/' + __version__,
+    classifiers=[
+        'Intended Audience :: Developers',
+        'License :: OSI Approved :: MIT License',
+        'Natural Language :: English',
+        'Programming Language :: Python',
+        'Programming Language :: Python :: 2.7',
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.4',
+    ],
+    keywords=['Dictionary', 'Vocabulary', 'simple dictionary', 'pydict', 'dictionary module']
 )

vocabulary/version.py

@@ -0,0 +1,4 @@
+# -*- coding: utf-8 -*-
+
+VERSION = '1.0.0'
+RELEASE = '6'

vocabulary/vocabulary.py

@@ -28,7 +28,10 @@
 
 from .responselib import Response
 
-__version__ = '0.0.6'
+from .version import VERSION, RELEASE
+
+__version__ = VERSION
+__release__ = RELEASE
 __author__ = "Tasdik Rahman"