Skip to content

Commit

Permalink
Update docs, release 3.0.1
Browse files Browse the repository at this point in the history
  • Loading branch information
phoenixr-codes committed Apr 22, 2023
1 parent e9cbe59 commit b5a1f6b
Show file tree
Hide file tree
Showing 10 changed files with 22 additions and 43 deletions.
12 changes: 6 additions & 6 deletions docs/api.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,36 @@
# API Reference

## aprompt
## `aprompt`

```{eval-rst}
.. automodule:: aprompt
```

## aprompt.exceptions
## `aprompt.exceptions`

```{eval-rst}
.. automodule:: aprompt.exceptions
```

## aprompt.formatters
## `aprompt.formatters`

```{eval-rst}
.. automodule:: aprompt.formatters
```

## aprompt.prompts
## `aprompt.prompts`

```{eval-rst}
.. automodule:: aprompt.prompts
```

## aprompt.result
## `aprompt.result`

```{eval-rst}
.. automodule:: aprompt.result
```

## aprompt.widgets
## `aprompt.widgets`

```{eval-rst}
.. automodule:: aprompt.widgets
Expand Down
31 changes: 4 additions & 27 deletions docs/changelog.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,11 @@
# Changelog

## 3.0.0.post1 (??-??-????)
## 3.0.1 (22-04-2023)

* 📄 Improved documentation
* ➕ {func}`aprompt.prompts.choice` now supports containers for the `require` argument.

## 3.0.0 (22-03-2023)

* 🌠 First Release (kind of[^1])

## 3.0.0 (22-03-2023)

[^1]:
```{admonition} Background Knowledge
---
class: tip
---
What happened to prior versions (`<3`)?
> *aprompt* started as a project with a slight different approach: All
> prompts were decorators where each decorated function would take the
> input invoked by the decorator. This version did not contain
> formatters and whatsoever.
>
> Version 2 is the origin of the latest version. While it had
> formatters (called `themes`), the structure was not so pythonic
> as it is now.
* 🌠 First Release (kind of)

What was the motivation of this project?
> Most python libraries either use `input` or a library like
> [python-inquirer](https://github.com/magmax/python-inquirer).
> The first method does not look that good and is not that user
> friendly. The latter one does not provide customization and a
> dynamic control flow. For most projects this will probably
> still suit your usage 😁.
```
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
project = 'aprompt'
copyright = '2023, phoenixR'
author = 'phoenixR'
release = '3.0.0'
release = '3.0.1'


###############
Expand Down
5 changes: 3 additions & 2 deletions docs/contributing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,13 @@
🏗️ Work In Progress
```

```text
```console
git clone https://github.com/phoenixr-codes/aprompt.git &&
cd $_ &&
pip install .[docs,dev]
```

```text
```console
tox run
```

2 changes: 1 addition & 1 deletion docs/customization/custom-prompt-engine.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ from aprompt import PromptEngine
from aprompt.result import Result
from readchar import keys as k
def my_prompt(arguments) -> PromptEngine[result_type]:
def my_prompt(arguments) -> PromptEngine[ResultType]:
alert = False
while True:
key = yield [
Expand Down
2 changes: 1 addition & 1 deletion docs/extensions.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Extensions

## aprompt.ext.argparse
## `aprompt.ext.argparse`

```{eval-rst}
.. automodule:: aprompt.ext.argparse
Expand Down
1 change: 1 addition & 0 deletions docs/license.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Limitations
> * Liability
> * Warranty
------------------------------------------------------------------------------

```text
MIT License
Expand Down
5 changes: 1 addition & 4 deletions docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,7 @@ of your first prompt.

You can install aprompt with [pip](https://pip.pypa.io/en/stable/):

```{code-block} text
---
caption: Console
---
```console
pip install -U aprompt
```

Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"

[project]
name = "aprompt"
version = "3.0.0.post1"
version = "3.0.1"
description = "Advanced Prompts"
readme = "README.md"
requires-python = ">=3.10"
Expand Down
3 changes: 3 additions & 0 deletions src/aprompt/prompts.py
Original file line number Diff line number Diff line change
Expand Up @@ -240,6 +240,9 @@ def choice(
"""Prompts for options.
.. image:: media/prompt-choice.gif
.. versionadded:: 3.0.1
``require`` now accepts containers.
Parameters
----------
Expand Down

0 comments on commit b5a1f6b

Please sign in to comment.