8000 Merge branch 'pyscript:main' into main · yannickfunk/pyscript@583ceb8 · GitHub
[go: up one dir, main page]
Skip to content

Commit 583ceb8

Browse files
yannickfunkyannickfunk
authored
Merge branch 'pyscript:main' into main
2 parents a273932 + 698478e commit 583ceb8

File tree

129 files changed

+810
-4608
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

129 files changed

+810
-4608
lines changed

‎.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
name: Bug Report
2+
description: Create a report to help us improve
3+
labels: ["type: bug", "needs-triage"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for helping PyScript! 🐍
9+
10+
Going through bugs and issues takes up a lot of time, so please be so kind and take a few minutes to fill out all the areas to the best of your ability.
11+
12+
There will always be more issues than there is time to do them, and so we will need to selectively close issues that don't provide enough information, so we can focus our time on helping people like you who fill out the issue form completely. Thank you for your collaboration!
13+
14+
There are also already a lot of open issues, so please take 2 minutes and search through existing ones to see if what you are experiencing already exists
15+
16+
Thanks for helping PyScript be amazing. We are nothing without people like you helping build a better community 💐!
17+
- type: checkboxes
18+
id: checks
19+
attributes:
20+
label: Checklist
21+
description: Please confirm and check all the following options.
22+
options:
23+
- label: I added a descriptive title
24+
required: true
25+
- label: I searched for other issues and couldn't find a solution or duplication
26+
required: true
27+
- label: I already searched in Google and didn't find any good information or help
28+
required: true
29+
- type: textarea
30+
id: what-happened
31+
attributes:
32+
label: What happened?
33+
description: And what should have happened instead? This really helps everyone review quicker and greatly increases the chance that someone can get around to solve your issue
34+
placeholder: Tell us what you see!
35+
validations:
36+
required: true
37+
- type: dropdown
38+
id: browsers
39+
attributes:
40+
label: What browsers are you seeing the problem on? (if applicable)
41+
multiple: true
42+
options:
43+
- Firefox
44+
- Chrome
45+
- Safari
46+
- Microsoft Edge
47+
- Other
48+
validations:
49+
required: false
50+
- type: textarea
51+
id: list
52+
attributes:
53+
label: Console info
54+
description: |
55+
If there are errors in your browser console then its helpful to be able to troubleshoot.
56+
- Chrome , Firefox, and Edge: Right-click on the page and select *Inspect*. Alternatively you can press F12 on your keyboard.
57+
- Safari: Find instructions [here](https://support.apple.com/guide/safari/use-the-developer-tools-in-the-develop-menu-sfri20948/mac).
58+
render: shell
59+
- type: textarea
60+
id: context
61+
attributes:
62+
label: Additional Context
63+
description: Add any additional context information or screenshots you think are useful.

‎.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 23 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Question
4+
url: https://community.anaconda.cloud/c/tech-topics/pyscript
5+
about: For questions or discussions about pyscript

‎.github/ISSUE_TEMPLATE/feature-request.yml

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
name: Feature Request
2+
description: Create a feature request to make PyScript even better
3+
labels: ["type: enhancement", "needs-triage"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
### Thanks for helping PyScript! 🐍
9+
10+
Going through feature requests and issues takes up a lot of time, so please be so kind and take a few minutes to fill out all the areas to the best of your ability.
11+
12+
There will always be more great ideas than there is time to do them, and so we will need to selectively close issues that don't provide enough information, so everyone can focus our time on helping people like you who fill out the form completely. Thank you for your collaboration!
13+
14+
There are also already a lot of open requests, so please take 2 minutes and search through existing ones to see if your idea already exists. If you find something close, please upvote that request and comment.
15+
16+
Thanks for helping PyScript be amazing. We are nothing without people like you helping build a better community 💐!
17+
18+
### Lets make sure you are in the right place. If you have an idea/request for:
19+
20+
- #### A specific package/library (such as pandas or scikit learn):
21+
22+
Search for that respective library on github repo or website. You will have much more success there.
23+
24+
- #### A general Python question/feature request:
25+
26+
Try out a forum post [here](https://discuss.python.org/c/users/7)
27+
28+
- type: checkboxes
29+
id: checks
30+
attributes:
31+
label: Checklist
32+
description: Please confirm and check all the following options
33+
options:
34+
- label: I added a descriptive title
35+
required: true
36+
- label: I searched for other feature requests and couldn't find a duplicate (including also the ``type-feature`` tag)
37+
required: true
38+
- label: I confirmed that it's not related to another project are area (see the above section)
39+
required: true
40+
- type: textarea
41+
id: request-idea
42+
attributes:
43+
label: What is the idea?
44+
description: Describe what the feature is and the desired state
45+
placeholder: This feature would allow any user of PyScript to type in a simple command in the console and show all variables currently in use
46+
validations:
47+
required: true
48+
- type: textarea
49+
id: why
50+
attributes:
51+
label: Why is this needed
52+
description: |
53+
Who would benefit from this and why would this add value to them? What problem does this solve?
54+
placeholder: This would benefit users who would like to see what is being used so they can learn and debug faster
55+
- type: textarea
56+
id: what
57+
attributes:
58+
label: What should happen?
59+
description: |
60+
What should be the user experience with the feature? Describe from a user perpective what they would do and see
61+
placeholder: A user would type in ``PyScript debug`` in the browser console and see a list of all variables created.
62+
- type: textarea
63+
id: context
64+
attributes:
65+
label: Additional Context
66+
description: |
67+
Is there any other information that you think would be valuable for the team to know?

‎.github/ISSUE_TEMPLATE/feature_request.md

Expand all lines: .github/ISSUE_TEMPLATE/feature_request.md
Lines changed: 0 additions & 20 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/misc.yml

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: Miscellaneous
2+
description: For issues that don't belong in other categories
3+
labels: ["type: misc", "needs-triage"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for helping PyScript! 🐍
9+
10+
This issue is for things that doesn't make sense to put into the other issue categories and we don't want it to get lost.
11+
12+
Going through issues takes up a lot of time, so please be so kind and take a few minutes to fill out all the areas to the best of your ability.
13+
14+
There will always be more issues than there is time to do them, and so we will need to selectively close issues that don't provide enough information, so we can focus our time on helping people like you who fill out the issue form completely. Thank you for your collaboration!
15+
16+
There are also already a lot of open issues, so please take 2 minutes and search through existing ones to see if what you are experiencing already exists
17+
18+
Thanks for helping PyScript be amazing. We are nothing without people like you helping build a better community 💐!
19+
- type: checkboxes
20+
id: checks
21+
attributes:
22+
label: Checklist
23+
description: Please confirm and check all the following options.
24+
options:
25+
- label: I added a descriptive title
26+
required: true
27+
- label: I searched for other issues and couldn't find a duplication
28+
required: true
29+
- label: I already searched in Google and didn't find any good information or help
30+
required: true
31+
- type: textarea
32+
id: what
33+
attributes:
34+
label: What is the issue/comment/problem?
35+
description: This is a miscellaneous issue so this could be just about anything. We simply ask that you provide as many details as you can to help spur discussion or the outcome you want.
36+
validations:
37+
required: true

‎.github/workflows/build-alpha.yml

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -47,17 +47,12 @@ jobs:
4747
- name: setup Miniconda
4848
uses: conda-incubator/setup-miniconda@v2
4949

50-
- name: Install dependencies
51-
run: |
52-
npm install
53-
make setup
50+
- name: Setup Environment
51+
run: make setup
5452

55-
- name: Test pyscript
53+
- name: Build and Test
5654
run: make test
5755

58-
- name: Build pyscript
59-
run: make build
60-
6156
# Deploy to S3
6257
- name: Configure AWS credentials
6358
if: github.ref == 'refs/heads/main' # Only deploy on merge into main

‎.github/workflows/build-latest.yml

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -55,17 +55,12 @@ jobs:
5555
- name: setup Miniconda
5656
uses: conda-incubator/setup-miniconda@v2
5757

58-
- name: Install dependencies
59-
run: |
60-
npm install
61-
make setup
58+
- name: Setup Environment
59+
run: make setup
6260

63-
- name: Test pyscript
61+
- name: Build and Test
6462
run: make test
6563

66-
- name: Build pyscript
67-
run: make build
68-
6964
# Deploy to S3
7065
- name: Configure AWS credentials
7166
if: github.ref == 'refs/heads/main' # Only deploy on merge into main

‎.github/workflows/sync-examples.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
name: '[CI] Sync Examples'
22

33
on:
4-
push: # Only run on merges into main that modify files under pyscriptjs/examples/
4+
push: # Only run on merges into main that modify files under examples/
55
branches:
66
- main
77
paths:
8-
- pyscriptjs/examples/**
8+
- examples/**
99
- .github/workflows/sync-examples.yml # Test that workflow works when changed
1010

1111
jobs:
@@ -16,7 +16,7 @@ jobs:
1616
id-token: write
1717
defaults:
1818
run:
19-
working-directory: pyscriptjs/examples
19+
working-directory: examples
2020

2121
steps:
2222

‎.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ coverage.xml
5151
*.py,cover
5252
.hypothesis/
5353
.pytest_cache/
54+
pyscriptjs/examples
5455

5556
# Translations
5657
*.mo

‎.pre-commit-config.yaml

Expand all lines: .pre-commit-config.yaml
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ repos:
5555
hooks:
5656
- id: pretty-format-yaml
5757
args: [--autofix, --indent, '4']
58+
exclude: .github/ISSUE_TEMPLATE/.*\.yml$
5859

5960
- repo: https://github.com/asottile/pyupgrade
6061
rev: v2.32.1
@@ -64,7 +65,7 @@ repos:
6465
- --py310-plus
6566

6667
- repo: https://github.com/pre-commit/mirrors-eslint
67-
rev: v8.15.0
68+
rev: v8.16.0
6869
hooks:
6970
- id: eslint
7071
files: pyscriptjs/src/.*\.[jt]sx?$ # *.js, *.jsx, *.ts and *.tsx

‎CONTRIBUTING.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,9 +84,10 @@ To create a change for PyScript, you can follow the process described [here](htt
8484

8585
This Project welcomes contributions, suggestions, and feedback. All contributions, suggestions, and feedback you submitted are accepted under the [Apache 2.0](./LICENSE) license. You represent that if you do not own copyright in the code that you have the authority to submit it under the [Apache 2.0](./LICENSE) license. All feedback, suggestions, or contributions are not confidential.
8686

87+
8788
## Becoming a maintainer
8889

89-
Contributors are invited to be maintainers to the project by demonstrating good decision making in their contributions, a commitment to the goals of the project, and consistent adherence to the [code of conduct](https://github.com/pyscript/governance/blob/main/CODE-OF-CONDUCT.md). New maintainers are invited by a 3/4 vote of the existing maintainers.
90+
Contributors are invited to be maintainers of the project by demonstrating good decision making in their contributions, a commitment to the goals of the project, and consistent adherence to the [code of conduct](https://github.com/pyscript/governance/blob/main/CODE-OF-CONDUCT.md). New maintainers are invited by a 3/4 vote of the existing maintainers.
9091

9192
## Trademarks
9293

‎README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,12 @@
33
## What is PyScript
44

55
### Summary
6+
67
PyScript is a Pythonic alternative to Scratch, JSFiddle, and other "easy to use" programming frameworks, with the goal of making the web a friendly, hackable place where anyone can author interesting and interactive applications.
78

89
To get started see the [getting started tutorial](docs/tutorials/getting-started.md).
910

10-
For examples see [the pyscript folder](pyscriptjs).
11+
For examples see [here](examples).
1112

1213
### Longer Version
1314
PyScript is a meta project that aims to combine multiple open technologies into a framework that allows users to create sophisticated browser applications with Python. It integrates seamlessly with the way the DOM works in the browser and allows users to add Python logic in a way that feels natural both to web and Python developers.
@@ -24,11 +25,11 @@ You can then use PyScript components in your html page. PyScript currently imple
2425
* `<py-script>`: can be used to define python code that is executable within the web page. The element itself is not rendered to the page and is only used to add logic
2526
* `<py-repl>`: creates a REPL component that is rendered to the page as a code editor and allows users to write executable code
2627

27-
Check out the [pyscriptjs/examples](pyscriptjs/examples) folder for more examples on how to use it, all you need to do is open them in Chrome.
28+
Check out the [the examples directory](examples) folder for more examples on how to use it, all you need to do is open them in Chrome.
2829

2930
## How to Contribute
3031

31-
To contribute see the [CONTRIBUTING](CONTRIBUTING.md) document.
32+
Read the [contributing guide](CONTRIBUTING.md) to learn about our development process, reporting bugs and improvements, creating issues and asking questions.
3233

3334
## Resources
3435

‎docs/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ and contribute to discussions around PyScript and related topics.
66
## Getting started
77

88
Before you start contributing to the documentation, it's worthwhile to
9-
take a look at the general contributing guidelines for the PyScript project.
9+
take a look at the general contributing guidelines for the PyScript project. You can find these guidelines here
10+
[Contributing Guidelines](https://github.com/pyscript/pyscript/blob/main/CONTRIBUTING.md)
1011

1112
### Setup
1213

0 commit comments

Comments
 (0)
0