diff --git a/README.md b/README.md index 4b780e5..1ecb8b4 100644 --- a/README.md +++ b/README.md @@ -33,12 +33,20 @@ be found in the [user guide]. ### 1. Setup -Install Gin: +Install Gin with pip: ```shell pip install gin-config ``` +Install Gin from source: + +```shell +git clone https://github.com/google/gin-config +cd gin-config +python -m setup.py install +``` + Import Gin (without TensorFlow functionality): ```python diff --git a/docs/walkthrough.md b/docs/walkthrough.md index 4b780e5..1ecb8b4 100644 --- a/docs/walkthrough.md +++ b/docs/walkthrough.md @@ -33,12 +33,20 @@ be found in the [user guide]. ### 1. Setup -Install Gin: +Install Gin with pip: ```shell pip install gin-config ``` +Install Gin from source: + +```shell +git clone https://github.com/google/gin-config +cd gin-config +python -m setup.py install +``` + Import Gin (without TensorFlow functionality): ```python diff --git a/gin/__init__.py b/gin/__init__.py index 05d9677..829bf12 100644 --- a/gin/__init__.py +++ b/gin/__init__.py @@ -14,6 +14,7 @@ # limitations under the License. """Init file for Gin.""" +__version__ = '0.1.1' from gin.config import bind_parameter from gin.config import clear_config diff --git a/setup.py b/setup.py index e8e1a92..02ca6e8 100644 --- a/setup.py +++ b/setup.py @@ -23,6 +23,7 @@ import codecs from os import path +import gin from setuptools import find_packages from setuptools import setup @@ -32,18 +33,20 @@ with codecs.open(path.join(here, 'README.md'), encoding='utf-8') as f: long_description = f.read() +install_requires = ['six >= 1.10.0', 'enum34;python_version<"3.4"'] +test_requirements = ['six >= 1.10.0', 'absl-py >= 0.1.6'] setup( name='gin-config', - version='0.1', + version=gin.__version__, include_package_data=True, packages=find_packages(exclude=['docs']), # Required package_data={'testdata': ['testdata/*.gin']}, - install_requires=['six >= 1.10.0'], + install_requires=install_requires, extras_require={ # Optional 'tf': ['tensorflow >= 1.6'], }, - tests_require=['six >= 1.10.0', 'absl-py >= 0.1.6'], + tests_require=test_requirements, description='Gin-config: a lightweight configuration library for Python', long_description=long_description, url='https://github.com/google/gin-config', # Optional