rename save-user and datacollection folder to secret and collect

Author: yuukidach

LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [year] [fullname]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,6 +1,6 @@
 # twitchanal (Twitch Analytics)
 
-A command line tool for Twitch analytics.
+A command line tool for Twitch analytics. This is originally a group project of my class at school.
 
 ## Table of Contents
 
@@ -24,6 +24,12 @@ eGaming is one of the popular entertainments nowadays. Twitch is a live streamin
 pip3 install .
 ```
 
+Or for development:
+
+``` shell
+pip3 install -e .
+```
+
 ## Commands
 
 ``` shell

setup.py

@@ -4,10 +4,15 @@
 with open('requirements.txt') as f:
     required = f.read().splitlines()
 
+with open("README.md", "r") as fh:
+    long_description = fh.read()
+
 setup(name='twitchanal',
       version='0.0.2',
       author='yuukidach',
       author_email='[email protected]',
+      long_description=long_description,
+      long_description_content_type="text/markdown",
       install_requires = required,
       python_requires = '>=3.7',
       package_dir={'': 'src'},

src/twitchanal/cli.py

@@ -1,6 +1,6 @@
 import click
-from twitchanal.save_secret.save_secret import save_id_secret
-from twitchanal.datacollection.collect import collect_data
+from twitchanal.secret.secret import save_id_secret
+from twitchanal.collect.collect import collect_data
 
 
 @click.group()
@@ -10,12 +10,14 @@ def cli():
 
 
 @click.command()
-def save_user():
+@click.option('--dir', '-d', default='./',
+              help='Directory to store the secret.')
+def save_user(dir):
     """ Save user id and secret key in `secret.yaml`.
     """
     id = click.prompt('Please enter the client ID', type=str)
     secret = click.prompt('Please enter the secret key', type=str)
-    save_id_secret(id, secret)
+    save_id_secret(id, secret, dir)
 
 
 @click.command()

src/twitchanal/datacollection/__init__.py src/twitchanal/collect/__init__.py

@@ -6,7 +6,7 @@
 from twitchAPI.twitch import Twitch
 from twitchAPI.oauth import UserAuthenticator
 from twitchAPI.types import AuthScope
-from twitchanal.save_secret.save_secret import *
+from twitchanal.secret.secret import *
 
 
 def get_dataframe(data: dict) -> pd.DataFrame:

src/twitchanal/datacollection/collect.py src/twitchanal/collect/collect.py

@@ -4,32 +4,36 @@
 from typing import Tuple
 
 
-def save_id_secret(id: str, secret: str) -> bool:
+def save_id_secret(id: str, secret: str, dir :str="") -> bool:
     """ Save id and secret in yaml file.
 
     Args:
         id (str): user id
         secret (str): user secret key
+        dir (str): directory to store the `secret.yaml`
 
     Returns:
         bool: True
     """
+    path = os.path.join(dir, 'secret.yaml')
+    os.makedirs(os.path.dirname(path), exist_ok=True)
     data = {'client_id': id, 'secret_key': secret}
-    with open('secret.yaml', 'w') as f:
+    with open(path, 'w') as f:
         yaml.dump(data, f)
     return True
 
 
-def load_id_secret() -> Tuple[str, str]:
+def load_id_secret(dir: str="") -> Tuple[str, str]:
     """ Load id and secret from yaml file.
 
     Returns:
         (id, secret): return None if no valid data is gotten.
     """
     id = None
     secret = None
+    path = os.path.join(dir, 'secret.yaml')
     # check if `secret.yaml` exists
-    if (not os.path.exists('secret.yaml')):
+    if (not os.path.exists(path)):
         cprint(
             'Error: `secret.yaml` not found. '
             'Please go the the dir contains this file '