Skip to content

Commit dc0550d

Browse files
committed
🚀 Initial Release
1 parent bf613c9 commit dc0550d

20 files changed

+689
-1
lines changed

.gitattributes

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Source files
2+
# ============
3+
*.pxd text diff=python
4+
*.py text diff=python
5+
*.py3 text diff=python
6+
*.pyw text diff=python
7+
*.pyx text diff=python
8+
*.pyz text diff=python
9+
*.pyi text diff=python
10+
11+
# Binary files
12+
# ============
13+
*.db binary
14+
*.p binary
15+
*.pkl binary
16+
*.pickle binary
17+
*.pyc binary export-ignore
18+
*.pyo binary export-ignore
19+
*.pyd binary
20+
21+
*.ipynb text

.github/CODEOWNERS

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
* @xFGhoul @6nz
2+
3+
4+
*.py @xFGhoul @6nz

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: 🐛 Bug Report
2+
description: Create a report to help us improve Mai
3+
title: 'Bug: '
4+
body:
5+
- type: checkboxes
6+
attributes:
7+
label: Prerequisites
8+
description: Please ensure you have completed all of the following.
9+
options:
10+
- label: I have read the [Contributing Guidelines](https://github.com/xFGhoul/Mai/tree/dev/.github/CONTRIBUTING.md).
11+
required: true
12+
- label: I agree to follow the [Code of Conduct](https://github.com/xFGhoul/Mai/blob/dev/CODE_OF_CONDUCT.md).
13+
required: true
14+
- label: I have searched for [existing issues](https://github.com/xFGhoul/Mai/issues) that already report this problem, without success.
15+
required: true
16+
- label: I have checked if the issue is not labeled as 'to do' or 'done' in the [Mai Project](https://github.com/xFGhoul/Mai/projects/1).
17+
required: true
18+
- type: textarea
19+
attributes:
20+
label: Current Behavior
21+
description: A clear description of what the bug is and how it manifests.
22+
validations:
23+
required: true
24+
- type: textarea
25+
attributes:
26+
label: Expected Behavior
27+
description: A clear description of what you expected to happen.
28+
validations:
29+
required: true
30+
- type: textarea
31+
attributes:
32+
label: Steps to Reproduce
33+
description: Please explain the steps required to duplicate this issue.
34+
validations:
35+
required: true
36+
- type: input
37+
attributes:
38+
label: Full Command String
39+
description: Please send the command that was used
40+
placeholder: -ban @User ...
41+
- type: textarea
42+
attributes:
43+
label: Additional Information
44+
description: List any other information that is relevant to your issue. Stack traces, related issues, suggestions on how to fix, Stack Overflow links, etc.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
contact_links:
2+
- name: 📚 Documentation
3+
url: https://xfghoul.github.io/Mai/
4+
about: Before Making An Issue, Make Sure To Check The Documentation
5+
6+
- name: 📚 Developer Documentation
7+
url: https://github.com/xFGhoul/Mai/blob/dev/.github/CONTRIBUTING.md
8+
about: Make Sure To Check The Developer Documentation If This Issue Is Focused On Code
9+
10+
- name: 🤔 Support Question
11+
url: https://discord.gg/AZQpDFFtqK
12+
about: Ask Questions At Our Discord If The Documentation Was Not Of Any Help
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: 💡 Feature Request
2+
description: Suggest an idea for Mai
3+
title: 'Feature: '
4+
body:
5+
- type: checkboxes
6+
attributes:
7+
label: Prerequisites
8+
description: Please ensure you have completed all of the following.
9+
options:
10+
- label: I have read the [Contributing Guidelines](https://github.com/xFGhoul/Mai/tree/dev/.github/CONTRIBUTING.md).
11+
required: true
12+
- label: I agree to follow the [Code of Conduct](https://github.com/xFGhoul/Mai/blob/dev/CODE_OF_CONDUCT.md).
13+
required: true
14+
- label: I have searched for [existing issues](https://github.com/xFGhoul/Mai/issues) that already include this feature request, without success.
15+
required: true
16+
- type: textarea
17+
attributes:
18+
label: Describe the Feature Request
19+
description: A clear and concise description of what the feature does.
20+
validations:
21+
required: true
22+
- type: textarea
23+
attributes:
24+
label: Describe the Use Case
25+
description: A clear and concise use case for what problem this feature would solve.
26+
validations:
27+
required: true
28+
- type: textarea
29+
attributes:
30+
label: Describe Preferred Solution
31+
description: A clear and concise description of what you how you want this feature to be added to Mai
32+
- type: textarea
33+
attributes:
34+
label: Describe Alternatives
35+
description: A clear and concise description of any alternative solutions or features you have considered.
36+
- type: textarea
37+
attributes:
38+
label: Related Code
39+
description: If you are able to illustrate the feature request with an example, please do so.
40+
- type: textarea
41+
attributes:
42+
label: Additional Information
43+
description: List any other information that is relevant to your issue. Stack traces, related issues, suggestions on how to implement, Stack Overflow links, forum links, etc.

.github/SECURITY.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Security Policy
2+
3+
## Reporting a Vulnerability
4+
5+
If there are any vulnerabilities in **PythonProtector** project, don't hesitate to _report them_.
6+
7+
1. Contact Any [Development Leads](https://github.com/xFGhoul/PythonProtector/blob/dev/AUTHORS.md)
8+
2. Describe the vulnerability.
9+
10+
- If you have a fix, explain or attach it.
11+
- In the near time, expect a reply with the required steps. Also, there may be a demand for a pull request which include the fixes.
12+
13+
> You should not disclose the vulnerability publicly if you haven't received an answer in some weeks.
14+
> If the vulnerability is rejected, you may post it publicly within some hour of rejection, unless the rejection is withdrawn within that time period.
15+
> After the vulnerability has been fixed, you may disclose the vulnerability details publicly over some days.

AUTHORS.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Ghoul
2+
3+
Discord - `ghoul#0002`
4+
5+
# Marci
6+
7+
Discord - `Marci#4399`

HISTORY.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## 1.0 - 2022-09-18
2+
3+
Release Project

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,15 @@
11
# PythonProtector
2-
Protect Your Python Files
2+
3+
Protect Your Python Program
4+
5+
## Installation
6+
7+
```sh
8+
pip install git+https://github.com/xFGhoul/PythonProtector.git
9+
```
10+
11+
## Usage
12+
13+
Check out the [examples](https://github.com/xFGhoul/PythonProtector/blob/dev/examples/)
14+
15+
Made by `ghoul#0002` and `Marci#4399`

examples/main.py

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
from pyprotector import PythonProtector
2+
3+
from pathlib import Path
4+
5+
# -- Define Constants
6+
LOGGING_PATH = Path.home() / "AppData/Roaming/PythonProtector/logs/[Security]-{time:D-M-YY}.log" # -- This can be renamed
7+
8+
security = PythonProtector(debug=True, logs_path=LOGGING_PATH, webhook_url="")
9+
10+
if __name__ == "__main__":
11+
security.start() # -- Start Before Any Other Code Is Run
12+
# Other Code

0 commit comments

Comments
 (0)