Skip to content

Commit 36c7d3d

Browse files
authored
Merge pull request #110 from Point72/tkp/cop
Uplift to copier
2 parents 33f2f01 + 9105bd4 commit 36c7d3d

File tree

18 files changed

+498
-495
lines changed

18 files changed

+498
-495
lines changed

.copier-answers.yaml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Changes here will be overwritten by Copier
2+
_commit: 2d0c192
3+
_src_path: https://github.com/python-project-templates/base.git
4+
add_docs: false
5+
add_extension: js
6+
add_wiki: true
7+
8+
github: Point72
9+
project_description: csp-gateway is a framework for building high-performance streaming
10+
applications
11+
project_name: csp gateway
12+
python_version_primary: '3.9'
13+
team: Point72, L.P.

.gitattributes

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
examples/* linguist-documentation
2+
docs/* linguist-documentation
3+
*.ipynb linguist-documentation
4+
Makefile linguist-documentation
5+
6+
*.css text=auto eol=lf
7+
*.html text=auto eol=lf
8+
*.js text=auto eol=lf
9+
*.json text=auto eol=lf
10+
*.less text=auto eol=lf
11+
*.md text=auto eol=lf
12+
*.py text=auto eol=lf
13+
*.toml text=auto eol=lf
14+
*.ts text=auto eol=lf
15+
*.yaml text=auto eol=lf

.github/CODE_OF_CONDUCT.md

Lines changed: 47 additions & 98 deletions
Original file line numberDiff line numberDiff line change
@@ -2,126 +2,75 @@
22

33
## Our Pledge
44

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.
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
1411

1512
## Our Standards
1613

17-
Examples of behavior that contributes to a positive environment for our
18-
community include:
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
1916

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
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
2722

28-
Examples of unacceptable behavior include:
23+
Examples of unacceptable behavior by participants include:
2924

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
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
3328
* Public or private harassment
34-
* Publishing others' private information, such as a physical or email
35-
address, without their explicit permission
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
3631
* Other conduct which could reasonably be considered inappropriate in a
37-
professional setting
32+
professional setting
3833

39-
## Enforcement Responsibilities
34+
## Our Responsibilities
4035

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.
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
4539

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.
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
5045

5146
## Scope
5247

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.
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
5854

5955
## Enforcement
6056

6157
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62-
reported to the community leaders responsible for enforcement at [email protected].
63-
All complaints will be reviewed and investigated promptly and fairly.
64-
65-
All community leaders are obligated to respect the privacy and security of the
66-
reporter of any incident.
67-
68-
## Enforcement Guidelines
69-
70-
Community leaders will follow these Community Impact Guidelines in determining
71-
the consequences for any action they deem in violation of this Code of Conduct:
72-
73-
### 1. Correction
74-
75-
**Community Impact**: Use of inappropriate language or other behavior deemed
76-
unprofessional or unwelcome in the community.
77-
78-
**Consequence**: A private, written warning from community leaders, providing
79-
clarity around the nature of the violation and an explanation of why the
80-
behavior was inappropriate. A public apology may be requested.
81-
82-
### 2. Warning
58+
reported by contacting the project team at [email protected]. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
8363

84-
**Community Impact**: A violation through a single incident or series
85-
of actions.
86-
87-
**Consequence**: A warning with consequences for continued behavior. No
88-
interaction with the people involved, including unsolicited interaction with
89-
those enforcing the Code of Conduct, for a specified period of time. This
90-
includes avoiding interactions in community spaces as well as external channels
91-
like social media. Violating these terms may lead to a temporary or
92-
permanent ban.
93-
94-
### 3. Temporary Ban
95-
96-
**Community Impact**: A serious violation of community standards, including
97-
sustained inappropriate behavior.
98-
99-
**Consequence**: A temporary ban from any sort of interaction or public
100-
communication with the community for a specified period of time. No public or
101-
private interaction with the people involved, including unsolicited interaction
102-
with those enforcing the Code of Conduct, is allowed during this period.
103-
Violating these terms may lead to a permanent ban.
104-
105-
### 4. Permanent Ban
106-
107-
**Community Impact**: Demonstrating a pattern of violation of community
108-
standards, including sustained inappropriate behavior, harassment of an
109-
individual, or aggression toward or disparagement of classes of individuals.
110-
111-
**Consequence**: A permanent ban from any sort of public interaction within
112-
the community.
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
11367

11468
## Attribution
11569

116-
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
117-
version 2.0, available at
118-
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
119-
120-
Community Impact Guidelines were inspired by [Mozilla's code of conduct
121-
enforcement ladder](https://github.com/mozilla/diversity).
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
12272

12373
[homepage]: https://www.contributor-covenant.org
12474

125-
For answers to common questions about this code of conduct, see the FAQ at
126-
https://www.contributor-covenant.org/faq. Translations are available at
127-
https://www.contributor-covenant.org/translations.
75+
For answers to common questions about this code of conduct, see
76+
https://www.contributor-covenant.org/faq

.github/dependabot.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,4 @@ updates:
2222
labels:
2323
- "lang: javascript"
2424
- "part: dependencies"
25+

.github/workflows/copier.yaml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: Copier Updates
2+
3+
on:
4+
workflow_dispatch:
5+
schedule:
6+
- cron: "0 5 * * 0"
7+
8+
jobs:
9+
update:
10+
permissions:
11+
contents: write
12+
pull-requests: write
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: actions-ext/copier-update@main
16+
with:
17+
token: ${{ secrets.WORKFLOW_TOKEN }}

.github/workflows/wiki.yaml

Lines changed: 10 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Publish Docs
1+
name: Publish Wiki
22

33
on:
44
push:
@@ -20,24 +20,16 @@ jobs:
2020
deploy:
2121
runs-on: ubuntu-latest
2222
steps:
23-
- name: Checkout
24-
uses: actions/checkout@v4
25-
26-
- name: Make home file
27-
run: cp README.md docs/wiki/Home.md
28-
29-
- name: Install Python
30-
uses: actions/setup-python@v5
23+
- uses: actions/checkout@v4
24+
- run: cp README.md docs/wiki/Home.md
25+
- uses: Andrew-Chen-Wang/github-wiki-action@v5
3126
with:
32-
python-version: 3.11
33-
34-
- name: Install NBConvert
35-
run: pip install nbconvert
36-
37-
- name: Convert Example Notebooks to Markdown
38-
run: jupyter nbconvert examples/Client.ipynb --to markdown --output ../docs/wiki/Client.md
27+
path: docs/wiki
28+
29+
- uses: actions-ext/python/setup@main
30+
- run: pip install nbconvert
31+
- run: jupyter nbconvert examples/Client.ipynb --to markdown --output ../docs/wiki/Client.md
3932

40-
- name: Upload Documentation to Wiki
41-
uses: Andrew-Chen-Wang/github-wiki-action@v5
33+
- uses: Andrew-Chen-Wang/github-wiki-action@v5
4234
with:
4335
path: docs/wiki

0 commit comments

Comments
 (0)