mirror of
https://github.com/Paillat-dev/pycord-rest.git
synced 2026-01-02 00:56:19 +00:00
📝 Update pyproject.toml and README.md to use fancy pypi readme (#12)
This commit is contained in:
12
README.md
12
README.md
@@ -1,6 +1,8 @@
|
|||||||
<div align="center">
|
<div align="center">
|
||||||
<h1>Pycord REST</h1>
|
<h1>Pycord REST</h1>
|
||||||
|
|
||||||
|
<!-- badges -->
|
||||||
|
|
||||||
[](https://pypi.org/project/pycord-rest-bot/)
|
[](https://pypi.org/project/pycord-rest-bot/)
|
||||||
[](https://pypi.org/project/pycord-rest-bot/)
|
[](https://pypi.org/project/pycord-rest-bot/)
|
||||||
[](https://pypi.org/project/pycord-rest-bot/)
|
[](https://pypi.org/project/pycord-rest-bot/)
|
||||||
@@ -8,11 +10,19 @@
|
|||||||
[](https://github.com/Paillat-dev/pycord-rest/actions/workflows/CI.yaml)
|
[](https://github.com/Paillat-dev/pycord-rest/actions/workflows/CI.yaml)
|
||||||
[](https://results.pre-commit.ci/latest/github/Paillat-dev/pycord-rest/main)
|
[](https://results.pre-commit.ci/latest/github/Paillat-dev/pycord-rest/main)
|
||||||
|
|
||||||
|
<!-- end badges -->
|
||||||
|
|
||||||
|
<!-- short description -->
|
||||||
|
|
||||||
A lightweight wrapper for Discord's HTTP interactions and webhook events using py-cord
|
A lightweight wrapper for Discord's HTTP interactions and webhook events using py-cord
|
||||||
and FastAPI.
|
and FastAPI.
|
||||||
|
|
||||||
|
<!-- end short description -->
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<!-- toc -->
|
||||||
|
|
||||||
## Table of Contents
|
## Table of Contents
|
||||||
|
|
||||||
- [Overview](#overview)
|
- [Overview](#overview)
|
||||||
@@ -60,6 +70,8 @@ pip install pycord-rest-bot --prerelease=allow
|
|||||||
> [!NOTE]
|
> [!NOTE]
|
||||||
> The package is currently in pre-release.
|
> The package is currently in pre-release.
|
||||||
|
|
||||||
|
<!-- quick-start -->
|
||||||
|
|
||||||
## Quick Start
|
## Quick Start
|
||||||
|
|
||||||
```python
|
```python
|
||||||
|
|||||||
@@ -1,12 +1,11 @@
|
|||||||
[build-system]
|
[build-system]
|
||||||
requires = ["hatchling", "hatch-vcs"]
|
requires = ["hatchling", "hatch-vcs", "hatch-fancy-pypi-readme"]
|
||||||
build-backend = "hatchling.build"
|
build-backend = "hatchling.build"
|
||||||
|
|
||||||
[project]
|
[project]
|
||||||
name = "pycord-rest-bot"
|
name = "pycord-rest-bot"
|
||||||
dynamic = ["version", "urls"]
|
dynamic = ["version", "urls", "readme"]
|
||||||
description = "A discord rest-bot wrapper for pycord"
|
description = "A lightweight wrapper for Discord's HTTP interactions and webhook events using py-cord and FastAPI"
|
||||||
readme = "README.md"
|
|
||||||
authors = [
|
authors = [
|
||||||
{ name = "Paillat-dev", email = "me@paillat.dev" }
|
{ name = "Paillat-dev", email = "me@paillat.dev" }
|
||||||
]
|
]
|
||||||
@@ -47,6 +46,34 @@ version-file = "src/pycord_rest/_version.py"
|
|||||||
Homepage = "https://github.com/Paillat-dev/pycord-rest"
|
Homepage = "https://github.com/Paillat-dev/pycord-rest"
|
||||||
source_archive = "https://github.com/Paillat-dev/pycord-rest/archive/{commit_hash}.zip"
|
source_archive = "https://github.com/Paillat-dev/pycord-rest/archive/{commit_hash}.zip"
|
||||||
|
|
||||||
|
[tool.hatch.metadata.hooks.fancy-pypi-readme]
|
||||||
|
content-type = "text/markdown"
|
||||||
|
|
||||||
|
[[tool.hatch.metadata.hooks.fancy-pypi-readme.fragments]]
|
||||||
|
path = "README.md"
|
||||||
|
start-after = "<!-- badges -->\n"
|
||||||
|
end-before = "\n<!-- end badges -->"
|
||||||
|
|
||||||
|
[[tool.hatch.metadata.hooks.fancy-pypi-readme.fragments]]
|
||||||
|
text = "\n\n---\n"
|
||||||
|
|
||||||
|
[[tool.hatch.metadata.hooks.fancy-pypi-readme.fragments]]
|
||||||
|
path = "README.md"
|
||||||
|
start-after = "## Overview\n"
|
||||||
|
end-before = "\n## Installation"
|
||||||
|
|
||||||
|
[[tool.hatch.metadata.hooks.fancy-pypi-readme.fragments]]
|
||||||
|
path = "README.md"
|
||||||
|
start-after = "<!-- quick-start -->"
|
||||||
|
|
||||||
|
[[tool.hatch.metadata.hooks.fancy-pypi-readme.substitutions]]
|
||||||
|
pattern = '\[(.+?)\]\(((?!https?://)\S+?)\)'
|
||||||
|
replacement = '[\1](https://github.com/Paillat-dev/pycord-rest/tree/main\g<2>)'
|
||||||
|
|
||||||
|
[[tool.hatch.metadata.hooks.fancy-pypi-readme.substitutions]]
|
||||||
|
pattern = '\[!(NOTE|TIP|IMPORTANT|WARNING|CAUTION)\]'
|
||||||
|
replacement = '**\1**:'
|
||||||
|
|
||||||
[tool.hatchling]
|
[tool.hatchling]
|
||||||
name = "pycord-rest-bot"
|
name = "pycord-rest-bot"
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user