From fcf9f596dcf617cb095effe538d4448a12a27470 Mon Sep 17 00:00:00 2001 From: Visual Python <83543209+visualpython@users.noreply.github.com> Date: Fri, 7 May 2021 15:20:03 +0900 Subject: [PATCH] Update README.md --- README.md | 166 ++++++++++++++++++++++++++++++++---------------------- 1 file changed, 100 insertions(+), 66 deletions(-) diff --git a/README.md b/README.md index 934764c3..f54789cd 100644 --- a/README.md +++ b/README.md @@ -1,78 +1,112 @@ -# 1. Install Package ( windows / Linux / Mac ) -### 1.1. requirements -> - Python 3.x -> - jupyter notebook or anaconda env
-> _pip install jupyter_
-> or
-> _python -m pip install --user jupyter_
-> -> _pip3 install jupyter_
-> or
-> _python3 -m pip install --user jupyter_
- -### 1.2. Install VisualPython package -> **[pip / conda]**
-> _pip install visualpython_ - -### 1.3. Optional package -* jupyter_contrib_nbextensions
-* Install to manage nbtextensions visually. ->> **[pip]**
->> _pip install jupyter_contrib_nbextensions
_ - _jupyter contrib nbextension install --user_
->> **[conda - anaconda env]**
-> _conda install -c conda-forge jupyter_contrib_nbextensions_
- _jupyter contrib nbextension install --user_ - -# 2. Package controller for Linux/Mac/Windows -### 2.1. VisualPython contoller info - -> **usage: _visualpy [option]_**
+# Visual Python +[![PyPI version shields.io](https://img.shields.io/pypi/v/visualpython)](https://pypi.python.org/pypi/visualpython/) +[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-green)](https://www.gnu.org/licenses/gpl-3.0.html) +[![Website: VP Hub](https://img.shields.io/badge/Website-VP%20Hub-orange)](https://www.visualpython.ai) + + +
+ +## Introduction +Visual Python is a GUI-based Python code generator, developed on the Jupyter Notebook environment as an extension. +
+ +1. Key Features +* Automatically generates Python code based on a graphic user interface
+* Creates code blocks by tasks (such as data processing, visualization)
+* You can save the analysis process and share it (as .vp file) with others
+ +2. Who and What is it for?
+Visual Python is a data analytics solution for both Programmers & Non-programmers.
+ +Programmers can use the tool :
+* to save & reuse user-defined (or repeatedly used) code
+* to find Python packages and functions from the list
+ +Non-programmers will be able to :
+* learn the Python language more easily
+* manage big data with minimal coding skills
+ +
+ +## Getting Started + +### 1. Requirements + +Visual Python is developed as an extension on Jupyter Notebook.
+We recommend installing Anaconda (virtual environment). + +- Python version 3.x +- Jupyter notebook or Anaconda env
+ +### 2. How to Install + +**1) Open Anaconda prompt** + +* Windows : Click Start > Search or Select 'Anaconda Prompt'
+* Mac : Open Launchpad > Select 'Terminal' + +**2) Install package from** +``` +pip install visualpython +``` +
+ +Depending on your virtual environment settings, you may need to install Jupyter Extensions.
+To install Jupyter Extension, use commands either: ``` - optional arguments: - -h, help - show this help message and exit - -e, enable - enable VisualPython - -d, disable - disable VisualPython - -i, install - install VisualPython extensions - -un, uninstall - uninstall VisualPython packages - -up, upgrade - upgrade VisualPython Package - -v, version - show VisualPython current version +pip install jupyter_contrib_nbextensions ``` +or
+``` +conda install -c conda-forge jupyter_contrib_nbextensions +``` + +**3) Enable the package** +``` +visualpy install +``` + +**4) Activate Visual Python on Jupyter Notebook** + +Click orange square button on the right side of the Jupyter Notebook menu.
+ +### 3. Package Control Info +* Usage: visualpy **[option]**
+* Optional arguments: + +``` +help - show help menu +uninstall - uninstall packages +upgrade - version upgrade +version - version check +``` +
+ +## Mission & Vision + + +**Mission**
+To support technology and education so that anyone can leverage big data analytics to create a variety of social values. + +**Vision**
+To create an environment where you can learn and use big data analytics skills easily. + + +
+ +## License -### 2.2. Activate VisualPython -> _visualpy install_
-> or
-> _visualpy -i_ - -### 2.3. Disable VisualPython -> _visualpy disable_
-> or
-> _visualpy -d_ - -### 2.4. Enable VisualPython extension -> _visualpy enable_
-> or
-> _visualpy -e_ - -### 2.5. Upgrade VisualPython package version -> _visualpy upgrade_
-> or
-> _visualpy -up_ - -### 2.6. Uninstall VisualPython package -> _visualpy uninstall_
-> or
-> _visualpy -un_ +GNU GPLv3 (See LICENSE file).