Skip to content

Commit

Permalink
Compile readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
davegaeddert committed Feb 2, 2025
1 parent 22ea357 commit 96da607
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 3 deletions.
17 changes: 17 additions & 0 deletions plain-passwords/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,20 @@
# plain.password

Password authentication for Plain.

## Usage

To enable password authentication in your Plain application, add the `PasswordLoginView` to your `urls.py`:

```python
# app/urls.py
from plain.urls import path
from plain.passwords.views import PasswordLoginView

urlpatterns = [
path('login/', PasswordLoginView.as_view(), name='login'),
# ...
]
```

This sets up a basic login view where users can authenticate using their username and password.
12 changes: 11 additions & 1 deletion plain-pytest/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,14 @@ But a lot of people (myself included) prefer [pytest](https://docs.pytest.org/en

In Plain I've removed the Django test runner and a lot of the implications that come with it.
There are a few utilities that remain to make testing easier,
and `plain-test` is a wrapper around `pytest`.
and `plain test` is a wrapper around `pytest`.

## Usage

To run your tests with pytest, use the `plain test` command:

```bash
plain test
```

This will execute all your tests using pytest.
19 changes: 17 additions & 2 deletions plain-support/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,23 @@

# plain-support

Captcha...
Provides support forms for your application.

## Usage

Include the support URLs in your `urls.py`:

```python
# app/urls.py
from plain.urls import include, path
import plain.support.urls

urlpatterns = [
path("support/", include(plain.support.urls)),
# ...
]
```

## Security considerations

Most support forms allow you to type in an email address. Be careful, because anybody can pretend to be anybody else at this point. Converations either need to continue over email (which confirms they have access to the email account), or include a verification step (emailing a code to the email address, for example).
Most support forms allow you to type in an email address. Be careful, because anybody can pretend to be anybody else at this point. Conversations either need to continue over email (which confirms they have access to the email account), or include a verification step (emailing a code to the email address, for example).

0 comments on commit 96da607

Please sign in to comment.