Skip to content

Commit 6447d1d

Browse files
amadaluziaamadaluzia
committed
feat(coc): rework into toml
1 parent 8e3f53f commit 6447d1d

File tree

15 files changed

+1219
-129
lines changed

15 files changed

+1219
-129
lines changed

‎.editorconfig

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
root = true
2+
3+
[*.py]
4+
indent_style = space
5+
indent_size = 4

‎.github/workflows/generate-readme.yml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: "Generate README.md"
2+
on: "push"
3+
jobs:
4+
generateREADME:
5+
name: "Generate README.md"
6+
runs-on: "ubuntu-latest"
7+
steps:
8+
- name: "Checkout repository"
9+
uses: "actions/checkout@v4"
10+
- name: "Install Python"
11+
run: "sudo apt install python3 -y"
12+
- name: "Generate .venv"
13+
run: "python3 -m venv .venv"
14+
- name: "Source the venv"
15+
run: "source ./.venv/bin/activate"
16+
- name: "Update pip"
17+
run: "pip install --upgrade pip"
18+
- name: "Install poetry"
19+
run: "pip install poetry"
20+
- name: "Install code_of_conduct"
21+
run: "poetry install"
22+
- name: "Run code_of_conduct"
23+
run: "poetry run gencoc"
24+
- name: "Commit new README.md"
25+
run: "git config --global user.name \"${{ github.actor }}\"\n
26+
git config --global user.email \"${{ github.actor }}@users.noreply.github.com\"\n
27+
git add .\n
28+
git commit -m \"README.md: Update\" -m \"[skip ci]\"\n
29+
git push\n"

‎.github/workflows/toc.yml

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

‎.gitignore

Lines changed: 208 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,208 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[codz]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
11+
build/
12+
develop-eggs/
13+
dist/
14+
downloads/
15+
eggs/
16+
.eggs/
17+
lib/
18+
lib64/
19+
parts/
20+
sdist/
21+
var/
22+
wheels/
23+
share/python-wheels/
24+
*.egg-info/
25+
.installed.cfg
26+
*.egg
27+
MANIFEST
28+
29+
# PyInstaller
30+
# Usually these files are written by a python script from a template
31+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
32+
*.manifest
33+
*.spec
34+
35+
# Installer logs
36+
pip-log.txt
37+
pip-delete-this-directory.txt
38+
39+
# Unit test / coverage reports
40+
htmlcov/
41+
.tox/
42+
.nox/
43+
.coverage
44+
.coverage.*
45+
.cache
46+
nosetests.xml
47+
coverage.xml
48+
*.cover
49+
*.py.cover
50+
.hypothesis/
51+
.pytest_cache/
52+
cover/
53+
54+
# Translations
55+
*.mo
56+
*.pot
57+
58+
# Django stuff:
59+
*.log
60+
local_settings.py
61+
db.sqlite3
62+
db.sqlite3-journal
63+
64+
# Flask stuff:
65+
instance/
66+
.webassets-cache
67+
68+
# Scrapy stuff:
69+
.scrapy
70+
71+
# Sphinx documentation
72+
docs/_build/
73+
74+
# PyBuilder
75+
.pybuilder/
76+
target/
77+
78+
# Jupyter Notebook
79+
.ipynb_checkpoints
80+
81+
# IPython
82+
profile_default/
83+
ipython_config.py
84+
85+
# pyenv
86+
# For a library or package, you might want to ignore these files since the code is
87+
# intended to run in multiple environments; otherwise, check them in:
88+
# .python-version
89+
90+
# pipenv
91+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
92+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
93+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
94+
# install all needed dependencies.
95+
#Pipfile.lock
96+
97+
# UV
98+
# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
99+
# This is especially recommended for binary packages to ensure reproducibility, and is more
100+
# commonly ignored for libraries.
101+
#uv.lock
102+
103+
# poetry
104+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
105+
# This is especially recommended for binary packages to ensure reproducibility, and is more
106+
# commonly ignored for libraries.
107+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
108+
#poetry.lock
109+
#poetry.toml
110+
111+
# pdm
112+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
113+
# pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
114+
# https://pdm-project.org/en/latest/usage/project/#working-with-version-control
115+
#pdm.lock
116+
#pdm.toml
117+
.pdm-python
118+
.pdm-build/
119+
120+
# pixi
121+
# Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
122+
#pixi.lock
123+
# Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
124+
# in the .venv directory. It is recommended not to include this directory in version control.
125+
.pixi
126+
127+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
128+
__pypackages__/
129+
130+
# Celery stuff
131+
celerybeat-schedule
132+
celerybeat.pid
133+
134+
# SageMath parsed files
135+
*.sage.py
136+
137+
# Environments
138+
.env
139+
.envrc
140+
.venv
141+
env/
142+
venv/
143+
ENV/
144+
env.bak/
145+
venv.bak/
146+
147+
# Spyder project settings
148+
.spyderproject
149+
.spyproject
150+
151+
# Rope project settings
152+
.ropeproject
153+
154+
# mkdocs documentation
155+
/site
156+
157+
# mypy
158+
.mypy_cache/
159+
.dmypy.json
160+
dmypy.json
161+
162+
# Pyre type checker
163+
.pyre/
164+
165+
# pytype static type analyzer
166+
.pytype/
167+
168+
# Cython debug symbols
169+
cython_debug/
170+
171+
# PyCharm
172+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
173+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
174+
# and can be added to the global gitignore or merged into this file. For a more nuclear
175+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
176+
#.idea/
177+
178+
# Abstra
179+
# Abstra is an AI-powered process automation framework.
180+
# Ignore directories containing user credentials, local state, and settings.
181+
# Learn more at https://abstra.io/docs
182+
.abstra/
183+
184+
# Visual Studio Code
185+
# Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
186+
# that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
187+
# and can be added to the global gitignore or merged into this file. However, if you prefer,
188+
# you could uncomment the following to ignore the entire vscode folder
189+
# .vscode/
190+
191+
# Ruff stuff:
192+
.ruff_cache/
193+
194+
# PyPI configuration file
195+
.pypirc
196+
197+
# Cursor
198+
# Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
199+
# exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
200+
# refer to https://docs.cursor.com/context/ignore-files
201+
.cursorignore
202+
.cursorindexingignore
203+
204+
# Marimo
205+
marimo/_static/
206+
marimo/_lsp/
207+
__marimo__/
208+

‎CONTRIBUTING.md

Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
# Contributing to the Code of Conduct
2+
3+
> [!NOTE]
4+
> This is a living document, and will grow with time. Please be aware
5+
> that nothing in this document will last forever. Check back whenever
6+
> you want to contribute.
7+
8+
## How the Code of Conduct is created
9+
10+
Rules are made from sections, these sections are in a
11+
`section{index}.toml` that you can find in `code_of_conduct/sections/`.
12+
This is done to standardise the code of conduct format, as well as
13+
making it portable in case it were to be used in our own Tux for
14+
example. There are some quirks with the format due to using Markdown
15+
which will be described in this document.
16+
17+
## How to add new rules
18+
19+
A rule can be added by opening the section you want to add a new rule
20+
to (read [here](#how-to-add-a-new-section) if you want to make a new
21+
section) and add something of the following format:
22+
23+
```toml
24+
[[rule]]
25+
# EXPECTED TO EXIST
26+
title = "My new rule"
27+
description = """
28+
I am describing my new rule.
29+
"""
30+
31+
# OPTIONAL
32+
[[rule.expectations]]
33+
expectation = "Mild"
34+
description = """
35+
Hello world! This is your punishment for doing something bad! Feel the
36+
wrath of the sword!
37+
"""
38+
39+
[[rule.glossary]]
40+
word = "describing"
41+
meaning = "talking about"
42+
```
43+
44+
You are expected to keep every line around 72 characters long for
45+
readability purposes. You also should aim to use listing less as
46+
paragraphs tend to work just about as well without being unmemorable.
47+
Make sure the quotes and the text are separate from each other for
48+
readability.
49+
50+
## How to add a new section
51+
52+
To create a new section, you can create a new file in
53+
`code_of_conduct/sections`. Preferably, you can name it
54+
`section{index}.toml` for consistency. You must write it out like below:
55+
```toml
56+
title = "My section"
57+
58+
[[rule]]
59+
title = "My rule"
60+
description = "Description of my rule."
61+
62+
# fill in the rest
63+
```
64+
65+
## What to do after you made your changes
66+
67+
CI is not setup for this yet. As such, you will have to set up a
68+
development environment for Python **3.11 and higher** to regenerate
69+
the README file. This isn't an annoying process but we will eventually
70+
add CI to make this step irrelevant.
71+
72+
### Setting up your .venv
73+
74+
Before setting up `.venv`, please make sure you are running version
75+
3.11 or above by running `python --version`. After checking and
76+
verifying that you have a high enough version, you can setup a .venv by
77+
running this command in your shell:
78+
```
79+
$ python -m venv .venv
80+
```
81+
This will create a .venv directory which will contain a local
82+
development environment you can access by sourcing `.venv/bin/activate`.
83+
You will want to check for an activation script that supports your shell
84+
however. If you are on PowerShell, you will need to source
85+
`.venv/bin/activate.ps1`, fish users must source `activate.fish` and so
86+
on with other shells.
87+
88+
Once you are in your .venv environment, make sure pip is up to date by
89+
running this command:
90+
```
91+
pip install --upgrade pip
92+
```
93+
This is to prevent any vulnerabilities when installing software via pip,
94+
and therefore it will be safer. We will now need `poetry` as pip doesn't
95+
have a stable lockfile format as of now.
96+
97+
To install `poetry`, you must run this command:
98+
```
99+
$ pip install poetry
100+
```
101+
You will then be able to use poetry to install our package as well as
102+
any dependencies needed for said package. This can be done by running
103+
the following command:
104+
```
105+
$ poetry install
106+
```
107+
108+
You can then generate the README by running the following command:
109+
```
110+
$ python -m code_of_conduct
111+
```
112+
The README will then be modified to include your changed you made. You
113+
can now commit your work and make a pull request.

0 commit comments

Comments
 (0)