add setup

Author: suqingdong

MANIFEST.in

@@ -1,3 +1,2 @@
 include requirements.txt
 include nsfc/version/version.json
-include nsfc/data/*.db

nsfc/bin/__init__.py

@@ -1,24 +0,0 @@
-import click
-
-from nsfc import version_info
-from .crawl import main as crawl_cli
-from .build import main as build_cli
-from .query import main as query_cli
-
-
-@click.group(help=version_info['desc'])
-@click.version_option(version=version_info['version'])
-def cli(**kwargs):
-    pass
-
-
-def main():
-    cli.add_command(crawl_cli)
-    cli.add_command(build_cli)
-    cli.add_command(query_cli)
-    cli()
-
-
-
-if __name__ == '__main__':
-    main()

nsfc/bin/main.py

@@ -0,0 +1,26 @@
+import click
+
+from nsfc import version_info
+from nsfc.bin.crawl import main as crawl_cli
+from nsfc.bin.build import main as build_cli
+from nsfc.bin.query import main as query_cli
+
+
+CONTEXT_SETTINGS = dict(help_option_names=['-h', '--help'])
+
+@click.group(help=version_info['desc'], context_settings=CONTEXT_SETTINGS)
+@click.version_option(version=version_info['version'])
+def cli(**kwargs):
+    pass
+
+
+def main():
+    cli.add_command(crawl_cli)
+    cli.add_command(build_cli)
+    cli.add_command(query_cli)
+    cli()
+
+
+
+if __name__ == '__main__':
+    main()

nsfc/bin/query.py

@@ -5,12 +5,29 @@
 import click
 from simple_loggers import SimpleLogger
 
+# from nsfc import DEFAULT_DB
 from nsfc.db.model import Project
 from nsfc.db.manager import Manager
-from nsfc import DEFAULT_DB
 
-
-@click.command(no_args_is_help=True, name='query', help='query data from the local database')
+DEFAULT_DB = ''
+
+__epilog__ = click.style('''
+
+\b
+examples:
+    nsfc query -C
+    nsfc query -C -s approval_year 2019
+    nsfc query -C -s approval_year 2019 -s subject_code "%A%"
+    nsfc query -C -s approval_year 2015-2019 -s subject_code "%C01%"
+    nsfc query -o A.2019.jl -s approval_year 2019 -s subject_code "%A%"
+    nsfc query -F tsv -o A.2019.tsv -s approval_year 2019 -s subject_code "%A%"
+    nsfc query -L 5 -s approval_year 2019
+''', fg='yellow')
+
+@click.command(no_args_is_help=True,
+               name='query',
+               epilog=__epilog__,
+               help='query data from the local database')
 @click.option('-d', '--dbfile', help='the database file', default=DEFAULT_DB, show_default=True)
 
 @click.option('-s', '--search', help='the search string, eg. project_id 41950410575', multiple=True, nargs=2)
@@ -27,7 +44,7 @@
               show_choices=True, show_default=True)
 def main(**kwargs):
 
-    logger = SimpleLogger('QUERY')
+    logger = SimpleLogger('STATS')
     logger.level = logger.level_maps[kwargs['log_level']]
 
     logger.info(f'input arguments: {kwargs}')

setup.py

@@ -0,0 +1,41 @@
+import os
+import json
+import codecs
+from setuptools import setup, find_packages
+
+
+BASE_DIR = os.path.dirname(os.path.abspath(__file__))
+version_info = json.load(open(os.path.join(BASE_DIR, 'nsfc', 'version', 'version.json')))
+
+
+setup(
+    name=version_info['prog'],
+    version=version_info['version'],
+    author=version_info['author'],
+    author_email=version_info['author_email'],
+    description=version_info['desc'],
+    long_description=codecs.open(os.path.join(BASE_DIR, 'README.md'), encoding='utf-8').read(),
+    long_description_content_type="text/markdown",
+    url='https://github.com/suqingdong/nsfc',
+    project_urls={
+        'Documentation': 'https://nsfc.readthedocs.io',
+        'Tracker': 'https://github.com/suqingdong/nsfc/issues',
+    },
+    license='BSD License',
+    install_requires=codecs.open(os.path.join(BASE_DIR, 'requirements.txt'), encoding='utf-8').read().split('\n'),
+    packages=find_packages(),
+    include_package_data=True,
+    entry_points={'console_scripts': [
+        'nsfc = nsfc.bin.main:main',
+    ]},
+    classifiers=[
+        'Development Status :: 5 - Production/Stable',
+        'Operating System :: OS Independent',
+        'Intended Audience :: Developers',
+        'License :: OSI Approved :: MIT License',
+        'Programming Language :: Python',
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.8',
+        'Topic :: Software Development :: Libraries'
+    ]
+)