created a setup.py file for instaling the library and created entry_points for the cli script

ankitchiplunkar · ankitchiplunkar · commit 364182291b12 · 2018-05-24T10:15:02.000+02:00
diff --git a/ether_sql.py b/ether_sql.py
diff --git a/ether_sql/cli/__init__.py b/ether_sql/cli/__init__.py
@@ -1,17 +1,24 @@
 import click
 import logging
+from sqlalchemy import func
 
 from ether_sql.cli import sql, ether
+from ether_sql.session import Session
+from ether_sql.scrapper import scrape_blocks, add_block_number
+from ether_sql.models import Blocks
 
 logger = logging.getLogger(__name__)
 
 
 @click.group()
-@click.option('--settings', default='DefaultSettings', help='settings to run ether_sql')
+@click.option('--settings', default='DefaultSettings',
+              help='settings to run ether_sql')
 @click.pass_context
 def cli(ctx, settings):
     """CLI script for ether_sql"""
-    from ether_sql.session import Session
+    if ctx.obj is None:
+        ctx.obj = {}
+
     logger.debug('settings')
     ctx.obj['session'] = Session(settings=settings)
 
@@ -27,11 +34,10 @@ def cli(ctx, settings):
 def scrape_block_range(ctx, start_block_number, end_block_number):
     """
     Pushes the data between start_block_number and end_block_number in the
-    database
+    database. If no values are provided, the start_block_number is the last
+    block_number+1 in sql and end_block_number is the current block_number in
+    node
     """
-    from sqlalchemy import func
-    from ether_sql.scrapper import scrape_blocks
-    from ether_sql.models import Blocks
 
     # A DBSession() instance establishes all conversations with the database
     # and represents a "staging zone" for all the objects loaded into the
@@ -42,7 +48,8 @@ def scrape_block_range(ctx, start_block_number, end_block_number):
         end_block_number = session.w3.eth.blockNumber
         logger.debug(end_block_number)
     if start_block_number is None:
-        sql_block_number = session.db_session.query(func.max(Blocks.block_number)).scalar()
+        sql_block_number = session.db_session.query(
+                                func.max(Blocks.block_number)).scalar()
         if sql_block_number is None:
             start_block_number = 0
         else:
@@ -66,15 +73,15 @@ def scrape_block_range(ctx, start_block_number, end_block_number):
 @click.pass_context
 def scrape_block(ctx, block_number):
     """
-    Pushes the data in block_number in the database
+    Pushes the data at block=block_number in the database
     """
-    from ether_sql.scrapper import add_block_number
 
     session = ctx.obj['session']
     if block_number is not None:
         block_number = int(block_number)
         session = add_block_number(block_number=block_number,
                                    ether_sql_session=session)
+        logger.info("Commiting block: {} to sql".format(block_number))
         session.db_session.commit()
     else:
-        raise ValueError('Please provide a value of --block_number')
+        click.echo(ctx.get_help())
diff --git a/ether_sql/cli/ether.py b/ether_sql/cli/ether.py
@@ -10,7 +10,7 @@ def cli():
 
 
 @cli.command()
-def eth_blockNumber():
+def blockNumber():
     """
     Gives the most recent block number in the ether node
     """
diff --git a/ether_sql/cli/sql.py b/ether_sql/cli/sql.py
@@ -1,6 +1,8 @@
 import click
 import logging
-from ether_sql.models import base
+from sqlalchemy import func
+
+from ether_sql.models import base, Blocks
 
 logger = logging.getLogger(__name__)
 
@@ -32,15 +34,9 @@ def drop_tables(ctx):
 
 
 @cli.command()
-def sql_blockNumber():
+@click.pass_context
+def blockNumber(ctx):
     """ Gives the current highest block in database"""
-    from ether_sql import db_engine
-    from ether_sql.models import Blocks
-    from sqlalchemy import func
-    from sqlalchemy.orm import sessionmaker
-
-    DBSession = sessionmaker(bind=db_engine)
-    db_session = DBSession()
-
-    max_block_number = db_session.query(func.max(Blocks.block_number)).scalar()
+    session = ctx.obj['session']
+    max_block_number = session.db_session.query(func.max(Blocks.block_number)).scalar()
     click.echo("{}".format(max_block_number))
diff --git a/ether_sql/session.py b/ether_sql/session.py
@@ -7,7 +7,7 @@
     HTTPProvider,
 )
 from ether_sql.models import base
-from settings import (
+from ether_sql.settings import (
     DefaultSettings,
     TestSettings,
     ParityTestSettings,
diff --git a/ether_sql/settings.py b/ether_sql/settings.py
diff --git a/requirements.txt b/requirements.txt
@@ -3,7 +3,7 @@
 
 # SqlAlchemy
 sqlalchemy==1.2.4
-sqlalchemy-migrate==0.11.0
+alembic==0.9.9
 psycopg2-binary==2.7.4
 
 # CLI
diff --git a/setup.py b/setup.py
@@ -0,0 +1,53 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+from setuptools import (
+    find_packages,
+    setup,
+)
+
+
+setup(
+    name='ether_sql',
+    version='0.1.0',
+    description="""A python library to push ethereum blockchain data into an sql database.""",
+    long_description_markdown_filename='README.md',
+    author='Ankit Chiplunkar',
+    author_email='ankit@analyseether.com',
+    url='https://github.com/analyseether/ether_sql',
+    include_package_data=True,
+    install_requires=[
+        "web3",
+        "sqlalchemy==1.2.4",
+        "alembic==0.9.9",
+        "psycopg2-binary==2.7.4",
+        "Click==6.7",
+    ],
+    setup_requires=['setuptools-markdown'],
+    python_requires='>=3.5, <4',
+    extras_require={
+        'tester': [
+            "pytest==3.0.0",
+            "pytest-cov==2.2.1",
+        ],
+        'linter': [
+            "flake8==3.4.1",
+            "isort>=4.2.15,<5",
+        ],
+    },
+    entry_points='''
+        [console_scripts]
+        ether_sql=ether_sql.cli:cli
+    ''',
+    py_modules=['ether_sql'],
+    zip_safe=False,
+    keywords='ethereum',
+    packages=find_packages(exclude=["tests", "tests.*"]),
+    classifiers=[
+        'Development Status :: 3 - Alpha',
+        'Intended Audience :: Developers',
+        'Natural Language :: English',
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.5',
+        'Programming Language :: Python :: 3.6',
+    ],
+)

Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@`
`7`	`7`	`HTTPProvider,`
`8`	`8`	`)`
`9`	`9`	`from ether_sql.models import base`
`10`		`-from settings import (`
	`10`	`+from ether_sql.settings import (`
`11`	`11`	`DefaultSettings,`
`12`	`12`	`TestSettings,`
`13`	`13`	`ParityTestSettings,`