Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

initial work on rpep-0000 - "What is an RPEP?" #1

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.hatch
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# ReactPy Enhancement Proposals (RPEPs)

The repository contains documents that outline proposals for large changes to ReactPy.

## Creating an RPEP

- Install [Hatch](https://github.com/pypa/hatch)
- Clone this repository
- Run `hatch shell`
- Copy the [`template.md`](./blob/main/docs/template.md) into a new file at `docs/rpeps/RPEP-9999.md`
- Add it to the `nav` in [`mkdocs.yml`](./blob/main/mkdocs.yml)
- Fill out the template with your proposal
- See what it looks like by running `mkdocs serve`
- Create a pull request.

## License

`rpep` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
Empty file added docs/index.md
Empty file.
796 changes: 796 additions & 0 deletions docs/rpeps/RPEP-0000.md

Large diffs are not rendered by default.

47 changes: 47 additions & 0 deletions docs/template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# RPEP-9999 - Subtitle

A short (~200 word) description of the technical issue being addressed.

# Motivation

Clearly explain why the existing features of ReactPy is not inadequate to address the problem that the RPEP solves.

# Rationale

Describe why particular design decisions were made.

# Specification

Describe the details of any new feature.

# Backwards Compatibility

Describe potential impact and severity on pre-existing code.

# Security Implications

How could a malicious user take advantage of this new feature?

# How to Teach This

How to teach users, new and experienced, how to apply the RPEP to their work.

# Reference Implementation

Link to any existing implementation and details about its state, e.g. proof-of-concept.

# Rejected Ideas

Why certain ideas that were brought while discussing this PEP were not ultimately pursued.

# Open Issues

Any points that are still being decided/discussed.

# Footnotes

A collection of footnotes cited in the PEP, and a place to list non-inline hyperlink targets.

# Copyright

This document is placed in the public domain or under the MIT license.
62 changes: 62 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
nav:
- Home: index.md
- Proposals:
- RPEP-0000: rpeps/RPEP-0000.md
- Template: template.md

theme:
name: material
palette:
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/white-balance-sunny
name: Switch to light mode
primary: light blue
accent: light blue
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/weather-night
name: Switch to dark mode
primary: black
features:
- navigation.instant
- navigation.tabs
- navigation.top
- content.code.copy
icon:
repo: fontawesome/brands/github
logo: https://raw.githubusercontent.com/reactive-python/reactpy/main/branding/svg/reactpy-logo-square.svg
favicon: https://raw.githubusercontent.com/reactive-python/reactpy/main/branding/svg/reactpy-logo-square.svg

markdown_extensions:
- toc:
permalink: true
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.tabbed:
alternate_style: true
- pymdownx.highlight:
linenums: true
- pymdownx.superfences
- pymdownx.details
- pymdownx.inlinehilite
- admonition
- attr_list
- md_in_html
- pymdownx.keys

plugins:
- search
- section-index

site_name: ReactPy
site_description: ReactPy Enhancement Proposals
copyright: Copyright © 2023 Reactive Python
repo_url: https://github.com/reactive-python/rpeps
site_url: https://reactive-python.github.io/rpeps
repo_name: reactive-python/rpeps
edit_uri: edit/main
17 changes: 17 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

[project]
name = "rpeps"
version = "0.0.0"
description = 'ReactPy Enhancement Proposals'
requires-python = ">=3.7"
license = "MIT"
dependencies = [
"mkdocs",
"mkdocs-material",
"mkdocs-git-authors-plugin",
"mkdocs-minify-plugin",
"mkdocs-section-index",
]