Merge pull request #12 from mutairibassam/feature/project-repackaging

[feature] general enhancements

.gitignore

@@ -0,0 +1,165 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# vscode
+.vscode/
+.idea/
+
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

Main.py → yocial/Main.py

@@ -4,20 +4,19 @@
 # Ultimately, I want Main.py to only have command arguments processing. Will work on that later
 # Right now Main.py is used to demonstrate how to use the API
 import sys
-
-import Utils
-import private_constants
-from Instagram import Instagram
-from SocialDetector import SocialDetector
-from Telegram import Telegram
-from Whatsapp import Whatsapp
+import yocial.Utils as Utils
+#import private_constants
+from yocial.features.Instagram.Instagram import Instagram
+from yocial.features.SocialDetector import SocialDetector
+#from feature.Telegram.Telegram import Telegram
+#from feature.Whatsapp.Whatsapp import Whatsapp
 
 
 def main():
     phone_number_list = Utils.cmd_args_to_phone_number(sys.argv)
     detector = SocialDetector()
-    detector.add_social_app(Telegram(phone_number_list, private_constants.TELEGRAM_API_ID, private_constants.TELEGRAM_API_HASH))
-    detector.add_social_app(Whatsapp(phone_number_list))
+    #detector.add_social_app(Telegram(phone_number_list, private_constants.TELEGRAM_API_ID, private_constants.TELEGRAM_API_HASH))
+    #detector.add_social_app(Whatsapp(phone_number_list))
     detector.add_social_app(Instagram(phone_number_list))
     detector.detect()
     for number in phone_number_list:

Utils.py → yocial/Utils.py

@@ -1,6 +1,6 @@
 import os
 
-from PhoneNumber import PhoneNumber
+from yocial.features.PhoneNumber import PhoneNumber
 
 
 def file_to_phone_number(file_path):

yocial/__init__.py

@@ -0,0 +1,4 @@
+from os.path import dirname, basename, isfile, join
+import glob
+modules = glob.glob(join(dirname(__file__), "*.py"))
+__all__ = [ basename(f)[:-3] for f in modules if isfile(f) and not f.endswith('__init__.py')]

yocial/__main__.py

@@ -0,0 +1,9 @@
+
+
+'''
+Entry point to run yocial module `python3 -m yocial`.
+'''
+
+from yocial.Main import main
+
+main()

Instagram.py → yocial/features/Instagram/Instagram.py

@@ -7,8 +7,8 @@
 
 import requests
 
-import PhoneNumber
-from BaseSocialApp import BaseSocialApp
+import yocial.features.PhoneNumber as PhoneNumber
+from yocial.features.BaseSocialApp import BaseSocialApp
 
 API_URL = 'https://i.instagram.com/api/v1/'
 USERS_LOOKUP_URL = API_URL + 'users/lookup/'