Skip to content

Hotfixes #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 7, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
166 changes: 66 additions & 100 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,112 +1,78 @@
<!--
#========================================================================
# Filename : README.md
# Function : control visualpython for Window/Linux/Mac
# Creator : Black Logic
# Version : 1.1.0
# function : control visualpython for Mac/Linux
# Creator : BlackLogic - LJ
# version : 2.0
# License : GPLv3
# Date : 2020 07.27
# Mdate : 2021 05.06
# Mdate : 2020 12.24
#========================================================================
-->

# Visual Python
# 1. Install Package ( windows / Linux / Mac )
### 1.1. requirements
> - Python 3.x
> - jupyter notebook or anaconda env <br>
> _pip install jupyter_ <br>
> or <br>
> _python -m pip install --user jupyter_ <br>
>
> _pip3 install jupyter_ <br>
> or <br>
> _python3 -m pip install --user jupyter_ <br>

### 1.2. Install VisualPython package
> **[pip / conda]** <br>
> _pip install visualpython_

### 1.3. Optional package
* jupyter_contrib_nbextensions<br>
* Install to manage nbtextensions visually.
>> **[pip]**<br>
>> _pip install jupyter_contrib_nbextensions <br>_
_jupyter contrib nbextension install --user_ <br>
>> **[conda - anaconda env]** <br>
> _conda install -c conda-forge jupyter_contrib_nbextensions_ <br>
_jupyter contrib nbextension install --user_

# 2. Package controller for Linux/Mac/Windows
### 2.1. VisualPython contoller info

> **usage: _visualpy [option]_** <br>

[![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)


<br>

## Introduction
Visual Python is a GUI-based Python code generator, developed on the Jupyter Notebook environment as an extension.
<br>

1. Key Features
* Automatically generates Python code based on a graphic user interface <br>
* Creates code blocks by tasks (such as data processing, visualization) <br>
* You can save the analysis process and share it (as .vp file) with others <br>

2. Who and What is it for? <br>
Visual Python is a data analytics solution for both Programmers & Non-programmers. <br>

Programmers can use the tool : <br>
* to save & reuse user-defined (or repeatedly used) code <br>
* to find Python packages and functions from the list <br>

Non-programmers will be able to : <br>
* learn the Python language more easily <br>
* manage big data with minimal coding skills <br>

<br>

## Getting Started

### 1. Requirements

Visual Python is developed as an extension on Jupyter Notebook. <br>
We recommend installing Anaconda (virtual environment).

- Python version 3.x
- Jupyter notebook or Anaconda env <br>

### 2. How to Install

**1) Open Anaconda prompt**

* Windows : Click Start > Search or Select 'Anaconda Prompt' <br>
* Mac : Open Launchpad > Select 'Terminal'

**2) Install package from**
```
pip install visualpython
```
<br>

Depending on your virtual environment settings, you may need to install Jupyter Extensions.<br>
To install Jupyter Extension, use commands either:
```
pip install jupyter_contrib_nbextensions
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
```
or <br>
```
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. <br>

### 3. Package Control Info
* Usage: visualpy **[option]** <br>
* Optional arguments:

```
help - show help menu
uninstall - uninstall packages
upgrade - version upgrade
version - version check
```
<br>

## Mission & Vision


**Mission** <br>
To support technology and education so that anyone can leverage big data analytics to create a variety of social values.

**Vision** <br>
To create an environment where you can learn and use big data analytics skills easily.


<br>

## License

GNU GPLv3 (See LICENSE file).
### 2.2. Activate VisualPython
> _visualpy install_ <br>
> or <br>
> _visualpy -i_

### 2.3. Disable VisualPython
> _visualpy disable_ <br>
> or <br>
> _visualpy -d_

### 2.4. Enable VisualPython extension
> _visualpy enable_ <br>
> or <br>
> _visualpy -e_

### 2.5. Upgrade VisualPython package version
> _visualpy upgrade_ <br>
> or <br>
> _visualpy -up_

### 2.6. Uninstall VisualPython package
> _visualpy uninstall_ <br>
> or <br>
> _visualpy -un_
Loading