Skip to content

Commit 119d23c

Browse files
minjk-blminjk-bl
authored
Merge pull request #16 from minjk-bl/devops
Update #8 #9 #10 #11
2 parents c20c668 + 96b8290 commit 119d23c

File tree

10 files changed

+572
-333
lines changed

10 files changed

+572
-333
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: "[BUG] "
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Desktop (please complete the following information):**
27+
- OS: [e.g. iOS]
28+
- Browser [e.g. chrome, safari]
29+
- Version [e.g. 22]
30+
31+
**VisualPython Information (please complete the following information):**
32+
- Version [e.g. 1.1.0]
33+
34+
**Additional context**
35+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

‎.github/ISSUE_TEMPLATE/simple-devops-issues.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: simple devops issues
3+
about: issues with simple changes
4+
title: ''
5+
labels: small change
6+
assignees: minjk-bl
7+
8+
---
9+
10+
### TO-BE
11+
1.
12+
13+
14+
--------------------------------
15+
16+
### AS-IS (Optional)
17+
1.

‎CODE_OF_CONDUCT.md

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
hello@visualpython.ai.
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120+
121+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122+
enforcement ladder](https://github.com/mozilla/diversity).
123+
124+
[homepage]: https://www.contributor-covenant.org
125+
126+
For answers to common questions about this code of conduct, see the FAQ at
127+
https://www.contributor-covenant.org/faq. Translations are available at
128+
https://www.contributor-covenant.org/translations.

‎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)