Skip to content

Commit 7f19696

Browse files
rayzchenrayzchen
committed
Extra files
1 parent 5b4ff9e commit 7f19696

File tree

6 files changed

+255
-2
lines changed

6 files changed

+255
-2
lines changed

‎CODE_OF_CONDUCT.md

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Contributor Covenant 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+
our [discord server](https://discord.gg/zTn48BEbF9).
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.

‎LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2020-2021 Ray Chen
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,42 @@
1-
An editor to aid in creating PyUnity projects (see https://github.com/pyunity/pyunity).
1+
# PyUnity Editor
2+
3+
[![License](https://img.shields.io/pypi/l/pyunity-gui.svg?logo=python&logoColor=FBE072)](https://github.com/pyunity/pyunity-gui/blob/develop/LICENSE)
4+
[![PyPI version](https://img.shields.io/pypi/v/pyunity-gui.svg?logo=python&logoColor=FBE072)](https://pypi.python.org/pypi/pyunity-gui)
5+
[![Python version](https://img.shields.io/pypi/pyversions/pyunity-gui.svg?logo=python&logoColor=FBE072)](https://pypi.python.org/pypi/pyunity-gui)
6+
[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/pyunity/pyunity-gui.svg?logo=lgtm)](https://lgtm.com/projects/g/pyunity/pyunity-gui/context:python)
7+
[![Total alerts](https://img.shields.io/lgtm/alerts/g/pyunity/pyunity-gui.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/pyunity/pyunity-gui/alerts/)
8+
[![Discord](https://img.shields.io/discord/835911328693616680?logo=discord&label=discord)](https://discord.gg/zTn48BEbF9)
9+
[![Gitter](https://badges.gitter.im/pyunity/community.svg)](https://gitter.im/pyunity/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
10+
[![GitHub Repo stars](https://img.shields.io/github/stars/pyunity/pyunity-gui?logo=github)](https://github.com/pyunity/pyunity-gui/stargazers)
11+
12+
This is a pure Python editor to make PyUnity projects (see https://github.com/pyunity/pyunity-gui).
13+
PyUnity is a pure Python Game Engine that is only inspired by Unity and not bindings for Unity,
14+
therefore this Editor is completely separate, but inspired by the UnityEditor.
15+
16+
## Installing
17+
18+
The PyUnity Editor can be installed via pip:
19+
20+
> pip install pyunity-editor
21+
22+
Alternatively, you can clone the repository to build the package from source. These builds are sometimes broken, so use at your own risk. You can build as follows:
23+
24+
> git clone https://github.com/pyunity/pyunity-gui
25+
> git checkout master
26+
> python setup.py install
27+
28+
Its only dependencies are PyUnity, PyQt5 and Pillow. Microsoft Visual C++ Build Tools are required on Windows for building PyUnity from source (if there isn't a wheel available). The PyUnity Editor requires a PyUnity version of at least 0.7.1.
29+
30+
## Running
31+
To run the PyUnity Editor, you run this command from the terminal:
32+
33+
> pyunity-editor project/
34+
35+
where `project/` is your project folder. The PyUnity Editor will launch with a splash screen, then the editor window will appear.
36+
37+
## Contributing
38+
39+
If you would like to contribute, please
40+
first see the [contributing guidelines](https://github.com/pyunity/pyunity-gui/blob/mastser/contributing.md),
41+
check out the latest [issues](https://github.com/pyunity/pyunity-gui/issues)
42+
and then make a [pull request](https://github.com/pyunity/pyunity-gui/pulls).

‎contributing.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Contributing to PyUnity
2+
We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
3+
4+
- Reporting a bug
5+
- Discussing the current state of the code
6+
- Submitting a fix
7+
- Proposing new features
8+
- Becoming a maintainer
9+
10+
## We Develop with Github
11+
We use github to host code, to track issues and feature requests, as well as accept pull requests.
12+
13+
## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests
14+
Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests:
15+
16+
1. Fork the repo and create your branch from `main`.
17+
2. If you've added code that should be tested, add tests.
18+
3. If you've changed APIs, update the documentation.
19+
4. Ensure the test suite passes.
20+
5. Make sure your code lints.
21+
6. Issue that pull request!
22+
23+
## Any contributions you make will be under the MIT Software License
24+
In short, when you submit code changes, your submissions will be understood under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.
25+
26+
## Report bugs using Github's [issues](https://github.com/pyunity/pyunity-gui/issues)
27+
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/pyunity/pyunity-gui/issues/new); it's that easy!
28+
29+
**Great Bug Reports** tend to have:
30+
31+
- A quick summary and/or background
32+
- Steps to reproduce
33+
- Be specific!
34+
- Give sample code if you can. Please try to provide a [minimal reproducible example](https://stackoverflow.com/help/minimal-reproducible-example).
35+
- What you expected would happen
36+
- What actually happens
37+
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
38+
39+
People *love* thorough bug reports. I'm not even kidding.
40+
41+
## Use a Consistent Coding Style
42+
43+
* 4 spaces for indentation rather than tabs
44+
* Adhere to our naming convention (it's a little different to Python's standard one):
45+
46+
- PascalCase for class names
47+
- snake_case for user-defined functions and attributes
48+
- camelCase for all functions relating to PyQt5
49+
50+
* Add comments wherever needed, to explain what your changes do
51+
52+
## License
53+
By contributing, you agree that your contributions will be licensed under its MIT License.
54+
55+
## References
56+
This document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md).

‎editor/__init__.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
__version__ = "0.7.1"
2+
__copyright__ = "Copyright 2021 Ray Chen"
3+
__email__ = "tankimarshal2@gmail.com"
4+
__license__ = "MIT License"
5+
__summary__ = "An Editor for PyUnity in the style of the UnityEditor"
6+
__title__ = "pyunity-editor"
7+
__uri__ = "https://github.com/pyunity/pyunity-gui"

‎setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
"pillow",
3232
],
3333
python_requires='>=3',
34-
packages= ["editor"] + ["editor." + package for package in find_packages(where="editor")],
34+
packages=["editor"] + ["editor." + package for package in find_packages(where="editor")],
3535
package_data={"editor": [file[7:] for file in data_files]},
3636
entry_points={
3737
# "gui_scripts": [

0 commit comments

Comments
 (0)