setup: move to src and build the infra codes of upstream

.gitignore

@@ -152,4 +152,5 @@ backup_requirements.txt
 docs/source/_autosummary/
 tests/backup_test_shopee_data_explorer.py
 docs/backup_build_v1.3_desc_but_v1.5_api
-docs/backup_source_v1.3_desc_v1.5_api
+docs/backup_source_v1.3_desc_v1.5_api
+backup*

MANIFEST.in

@@ -0,0 +1,5 @@
+# MANIFEST.in
+
+include src/emarket_data_explorer/tools
+include src/emarket_data_explorer/tools/msj.ttf
+exclude tests/*

README.md

@@ -30,7 +30,7 @@ E-Market Data Explorer is a Python crawler and exploratory data analysis(EDA) to
 ## E-MarketDataExplorer HELP
 
 ```
-$ python -m emarket_data_explorer scrap-async --help
+$ python -m emarket_data_explorer --help
 
     Usage: emarket_data_explorer [OPTIONS] COMMAND [ARGS]...
 
@@ -66,18 +66,7 @@ $ python -m emarket_data_explorer scrap-async --help
 
 Please refer to the [E-Market Data Explorer online documentation](https://e-marketdataexplorer.readthedocs.io/en/latest/index.html) for Get-Started, EDA explanation, Testing and Troubleshooting
 
-
-## For Developer
-
-API docs is under actively development but we target v1.3 to release it.
-
-
-## Python Dependencies
-
-Please refer to requirements.txt and install all the required packages by
-```
-$ pip install -r requirements.txt
-```
+![doc_preview_github](https://user-images.githubusercontent.com/4502089/176811818-ffb5b503-cb72-444d-ae2d-0f75734c8d71.png)
 
 
 ## License
@@ -90,3 +79,6 @@ It is distributed under the Apache License. See LICENSE.txt for more information
 [Paul Yang](https://github.com/paulyang0125) ; [Kana Kunikata](https://github.com/vinavinak)
 
 
+## Roadmap
+
+We've developed [our roadmap of this utility](https://github.com/paulyang0125/E-MarketDataExplorer/wiki/E-MarketDataExplorer-Roadmap-Planning). Check it out if you're interested in joining us.

README.rst

@@ -1,5 +1,112 @@
-e-market data explorer tutorial
-=======================================
+E-MarketDataExplorer
+====================
 
-Search and collect product data and explore
-data through Exploratory Data Analysis (EDA) process
+|GitHub tag (latest by date)| |Documentation Status| |Build Status|
+|codecov| |Maintainability| |pylint Score| |image1| |image2|
+
+Overview
+--------
+
+E-Market Data Explorer is a Python crawler and exploratory data
+analysis(EDA) tool for marketing specialties who would like to conduct
+the STP methods for working out their marketing strategy for product
+development and sale.
+
+Preview
+-------
+
+E-MarketDataExplorer SCRAP
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. figure:: https://user-images.githubusercontent.com/4502089/176334966-56983073-f6dc-41c2-864b-323cd7766bf3.png
+   :alt: scrap-async
+
+   scrap-async
+
+E-MarketDataExplorer EDA
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. figure:: https://user-images.githubusercontent.com/4502089/173171695-fab53c6f-d429-466b-ab28-12c9fd57d2f9.png
+   :alt: app test
+
+   app test
+
+E-MarketDataExplorer HELP
+-------------------------
+
+::
+
+   $ python -m emarket_data_explorer --help
+
+       Usage: emarket_data_explorer [OPTIONS] COMMAND [ARGS]...
+
+       E-Market Data Explorer is a Python-based crawler and exploratory data
+       analysis(EDA) tool for marketing specialties who would like to conduct the
+       STP methods for working out their marketing strategy for sale and promotion.
+
+       Updated for E-Market Data Explorer 1.5, July 2022
+
+       Author:
+
+       Currently written and maintained by Paul Yang <paulyang0125@gmail> and Kana
+       Kunikata <[email protected]>.
+
+       Options:
+       -v, --version                   Show the application's version and exit.
+       --install-completion [bash|zsh|fish|powershell|pwsh]
+                                       Install completion for the specified shell.
+       --show-completion [bash|zsh|fish|powershell|pwsh]
+                                       Show completion for the specified shell, to
+                                       copy it or customize the installation.
+       --help                          Show this message and exit.
+
+       Commands:
+       eda          Create EDA process and charts from csv files
+       init         Initialize the shopee explorer data folder.
+       scrap-async  Scrap commercial data from the data source specified by user
+
+Quick-start
+-----------
+
+Please refer to the `E-Market Data Explorer online
+documentation <https://e-marketdataexplorer.readthedocs.io/en/latest/index.html>`__
+for Get-Started, EDA explanation, Testing and Troubleshooting
+
+.. figure:: https://user-images.githubusercontent.com/4502089/176811818-ffb5b503-cb72-444d-ae2d-0f75734c8d71.png
+   :alt: doc_preview_github
+
+   doc_preview_github
+
+License
+-------
+
+It is distributed under the Apache License. See LICENSE.txt for more
+information.
+
+Contact
+-------
+
+`Paul Yang <https://github.com/paulyang0125>`__ ; `Kana
+Kunikata <https://github.com/vinavinak>`__
+
+Roadmap
+-------
+
+We’ve developed `our roadmap of this
+utility <https://github.com/paulyang0125/E-MarketDataExplorer/wiki/E-MarketDataExplorer-Roadmap-Planning>`__.
+Check it out if you’re interested in joining us.
+
+.. |GitHub tag (latest by date)| image:: https://img.shields.io/github/v/tag/paulyang0125/E-MarketDataExplorer
+.. |Documentation Status| image:: https://readthedocs.org/projects/e-marketdataexplorer/badge/?version=latest
+   :target: https://e-marketdataexplorer.readthedocs.io/en/latest/?badge=latest
+.. |Build Status| image:: https://app.travis-ci.com/paulyang0125/E-MarketDataExplorer.svg?branch=main
+   :target: https://app.travis-ci.com/paulyang0125/E-MarketDataExplorer
+.. |codecov| image:: https://codecov.io/gh/paulyang0125/E-MarketDataExplorer/branch/main/graph/badge.svg?token=8J6QDFONV3
+   :target: https://codecov.io/gh/paulyang0125/E-MarketDataExplorer
+.. |Maintainability| image:: https://api.codeclimate.com/v1/badges/b873efdf1a77d343aeb3/maintainability
+   :target: https://codeclimate.com/github/paulyang0125/E-MarketDataExplorer/maintainability
+.. |pylint Score| image:: https://mperlet.github.io/pybadge/badges/8.53.svg
+.. |image1| image:: https://img.shields.io/badge/python-3.8+-blue.svg
+   :target: https://www.python.org/downloads/
+.. |image2| image:: https://img.shields.io/github/license/paulyang0125/E-MarketDataExplorer.svg
+   :target: https://github.com/paulyang0125/E-MarketDataExplorer/blob/main/LICENSE

pyproject.toml

@@ -1,8 +1,55 @@
 [build-system]
-requires = ["flit_core >=3.2,<4"]
-build-backend = "flit_core.buildapi"
+requires = ["setuptools>=61.0.0", "wheel"]
+build-backend = "setuptools.build_meta"
 
 [project]
-name = "E-market data explorer"
-authors = [{name = "Paul Yang", email = "[email protected]"}]
-dynamic = ["version", "description"]
+name = "emarket-data-explorer"
+version = "1.0.0"
+description = "Read ecommerce data and explore data through Exploratory Data Analysis"
+authors = [{name = "Paul Yang", email = "[email protected]"},{name = "Kana Kunikata", email = "[email protected]"}]
+classifiers = [
+    "License :: OSI Approved :: Apache Software License",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3.8",
+    "Operating System :: MacOS :: MacOS X",
+    "Operating System :: Microsoft :: Windows",
+]
+keywords = ["ecommerce", "data-analysis", "reader"]
+dependencies = [
+    "typer >= 0.4.1",
+    "pandas >= 1.4.3",
+    "matplotlib >= 3.5.2",
+    "adjustText >= 0.7.3",
+    "aiohttp >= 3.8.1",
+    "tqdm >= 4.64.0",
+    "bs4 >= 0.0.1",
+    "lxml >= 4.9.0",
+]
+requires-python = ">=3.8"
+
+[project.scripts]
+emarket-data-explorer = "emarket_data_explorer.__main__:main"
+
+[project.optional-dependencies]
+dev = ["bumpver", "Sphinx", "pip-tools", "pytest"]
+
+[tool.pytest.ini_options]
+pythonpath = [
+  "src"
+]
+[tool.bumpver]
+current_version = "1.0.0"
+version_pattern = "MAJOR.MINOR.PATCH"
+commit_message = "bump version {old_version} -> {new_version}"
+commit = true
+tag = true
+push = true
+
+[tool.bumpver.file_patterns]
+"pyproject.toml" = [
+    'current_version = "{version}"',
+]
+"setup.py" = [
+    "{version}"
+]
+"src/emarket_data_explorer/__init__.py" = ["{version}"]

pytest.ini

@@ -0,0 +1,2 @@
+[pytest]
+pythonpath = src/