Skip to content

Commit fcf9f59

Browse files
authored
Update README.md
1 parent 9788858 commit fcf9f59

File tree

1 file changed

+100
-66
lines changed

1 file changed

+100
-66
lines changed

README.md

Lines changed: 100 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -1,78 +1,112 @@
11
<!--
22
#========================================================================
33
# Filename : README.md
4-
# function : control visualpython for Mac/Linux
5-
# Creator : BlackLogic - LJ
6-
# version : 2.0
4+
# Function : control visualpython for Window/Linux/Mac
5+
# Creator : Black Logic
6+
# Version : 1.1.1
77
# License : GPLv3
88
# Date : 2020 07.27
9-
# Mdate : 2020 12.24
9+
# Mdate : 2021 05.07
1010
#========================================================================
1111
-->
1212

13-
# 1. Install Package ( windows / Linux / Mac )
14-
### 1.1. requirements
15-
> - Python 3.x
16-
> - jupyter notebook or anaconda env <br>
17-
> _pip install jupyter_ <br>
18-
> or <br>
19-
> _python -m pip install --user jupyter_ <br>
20-
>
21-
> _pip3 install jupyter_ <br>
22-
> or <br>
23-
> _python3 -m pip install --user jupyter_ <br>
24-
25-
### 1.2. Install VisualPython package
26-
> **[pip / conda]** <br>
27-
> _pip install visualpython_
28-
29-
### 1.3. Optional package
30-
* jupyter_contrib_nbextensions<br>
31-
* Install to manage nbtextensions visually.
32-
>> **[pip]**<br>
33-
>> _pip install jupyter_contrib_nbextensions <br>_
34-
_jupyter contrib nbextension install --user_ <br>
35-
>> **[conda - anaconda env]** <br>
36-
> _conda install -c conda-forge jupyter_contrib_nbextensions_ <br>
37-
_jupyter contrib nbextension install --user_
38-
39-
# 2. Package controller for Linux/Mac/Windows
40-
### 2.1. VisualPython contoller info
41-
42-
> **usage: _visualpy [option]_** <br>
13+
# Visual Python
4314

15+
[![PyPI version shields.io](https://img.shields.io/pypi/v/visualpython)](https://pypi.python.org/pypi/visualpython/)
16+
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-green)](https://www.gnu.org/licenses/gpl-3.0.html)
17+
[![Website: VP Hub](https://img.shields.io/badge/Website-VP%20Hub-orange)](https://www.visualpython.ai)
18+
19+
20+
<br>
21+
22+
## Introduction
23+
Visual Python is a GUI-based Python code generator, developed on the Jupyter Notebook environment as an extension.
24+
<br>
25+
26+
1. Key Features
27+
* Automatically generates Python code based on a graphic user interface <br>
28+
* Creates code blocks by tasks (such as data processing, visualization) <br>
29+
* You can save the analysis process and share it (as .vp file) with others <br>
30+
31+
2. Who and What is it for? <br>
32+
Visual Python is a data analytics solution for both Programmers & Non-programmers. <br>
33+
34+
Programmers can use the tool : <br>
35+
* to save & reuse user-defined (or repeatedly used) code <br>
36+
* to find Python packages and functions from the list <br>
37+
38+
Non-programmers will be able to : <br>
39+
* learn the Python language more easily <br>
40+
* manage big data with minimal coding skills <br>
41+
42+
<br>
43+
44+
## Getting Started
45+
46+
### 1. Requirements
47+
48+
Visual Python is developed as an extension on Jupyter Notebook. <br>
49+
We recommend installing Anaconda (virtual environment).
50+
51+
- Python version 3.x
52+
- Jupyter notebook or Anaconda env <br>
53+
54+
### 2. How to Install
55+
56+
**1) Open Anaconda prompt**
57+
58+
* Windows : Click Start > Search or Select 'Anaconda Prompt' <br>
59+
* Mac : Open Launchpad > Select 'Terminal'
60+
61+
**2) Install package from**
62+
```
63+
pip install visualpython
64+
```
65+
<br>
66+
67+
Depending on your virtual environment settings, you may need to install Jupyter Extensions.<br>
68+
To install Jupyter Extension, use commands either:
4469
```
45-
optional arguments:
46-
-h, help - show this help message and exit
47-
-e, enable - enable VisualPython
48-
-d, disable - disable VisualPython
49-
-i, install - install VisualPython extensions
50-
-un, uninstall - uninstall VisualPython packages
51-
-up, upgrade - upgrade VisualPython Package
52-
-v, version - show VisualPython current version
70+
pip install jupyter_contrib_nbextensions
5371
```
72+
or <br>
73+
```
74+
conda install -c conda-forge jupyter_contrib_nbextensions
75+
```
76+
77+
**3) Enable the package**
78+
```
79+
visualpy install
80+
```
81+
82+
**4) Activate Visual Python on Jupyter Notebook**
83+
84+
Click orange square button on the right side of the Jupyter Notebook menu. <br>
85+
86+
### 3. Package Control Info
87+
* Usage: visualpy **[option]** <br>
88+
* Optional arguments:
89+
90+
```
91+
help - show help menu
92+
uninstall - uninstall packages
93+
upgrade - version upgrade
94+
version - version check
95+
```
96+
<br>
97+
98+
## Mission & Vision
99+
100+
101+
**Mission** <br>
102+
To support technology and education so that anyone can leverage big data analytics to create a variety of social values.
103+
104+
**Vision** <br>
105+
To create an environment where you can learn and use big data analytics skills easily.
106+
107+
108+
<br>
109+
110+
## License
54111

55-
### 2.2. Activate VisualPython
56-
> _visualpy install_ <br>
57-
> or <br>
58-
> _visualpy -i_
59-
60-
### 2.3. Disable VisualPython
61-
> _visualpy disable_ <br>
62-
> or <br>
63-
> _visualpy -d_
64-
65-
### 2.4. Enable VisualPython extension
66-
> _visualpy enable_ <br>
67-
> or <br>
68-
> _visualpy -e_
69-
70-
### 2.5. Upgrade VisualPython package version
71-
> _visualpy upgrade_ <br>
72-
> or <br>
73-
> _visualpy -up_
74-
75-
### 2.6. Uninstall VisualPython package
76-
> _visualpy uninstall_ <br>
77-
> or <br>
78-
> _visualpy -un_
112+
GNU GPLv3 (See LICENSE file).

0 commit comments

Comments
 (0)