Skip to content

Improves the README with more badges, Pypi statistics, contributor recognition, and star history! #189

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.

Sign up for GitHub

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

Merged
rushter merged 5 commits into from
Nov 22, 2025
Merged

Improves the README with more badges, Pypi statistics, contributor recognition, and star history! #189

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3fe2c0a
Refine project description across metadata, documentation, and README…
pygarap Nov 21, 2025
eae3df7
Refine project description across setup, metadata, and documentation …
pygarap Nov 21, 2025
14deece
Clean up README by removing redundant badges and sections.
pygarap Nov 21, 2025
81bc41d
Refine README formatting and fix indentation in code examples for cla…
pygarap Nov 21, 2025
a9dfa31
Minor edits
rushter Nov 22, 2025
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
26 changes: 24 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,22 @@

---

[![PyPI version](https://img.shields.io/pypi/v/selectolax.svg)](https://pypi.python.org/pypi/selectolax)
A fast HTML5 parser with CSS selectors, written in Cython,
using [Modest](https://github.com/lexborisov/Modest/) and [Lexbor](https://github.com/lexbor/lexbor) engines.

A fast HTML5 parser with CSS selectors using [Modest](https://github.com/lexborisov/Modest/) and [Lexbor](https://github.com/lexbor/lexbor) engines.
---

[![PyPI - Version](https://img.shields.io/pypi/v/selectolax?logo=pypi&label=Pypi&logoColor=fff)](https://pypi.org/project/selectolax)
[![PyPI Total Downloads](https://static.pepy.tech/badge/selectolax)](https://pepy.tech/projects/selectolax)
[![PyPI Monthly Downloads](https://static.pepy.tech/badge/selectolax/month)](https://pepy.tech/projects/selectolax)
[![PyPI Weekly Downloads](https://static.pepy.tech/badge/selectolax/week)](https://pepy.tech/projects/selectolax)

[![Python Versions](https://img.shields.io/pypi/pyversions/selectolax?logo=python&logoColor=fff&label=Python)](https://pypi.org/project/selectolax)

[![CI](https://img.shields.io/github/actions/workflow/status/rushter/selectolax/pythonpackage.yml?branch=master&logo=githubactions&label=CI)](https://github.com/rushter/selectolax/actions/workflows/pythonpackage.yml?query=branch%3Amaster+event%3Apush)
[![GitHub License](https://img.shields.io/github/license/rushter/selectolax?logo=github&label=License)](https://github.com/rushter/selectolax/blob/master/LICENSE)

---

## Installation

Expand Down Expand Up @@ -152,3 +165,12 @@ Out[4]: '2021-08-15'
* Modest engine — [LGPL2.1](https://github.com/lexborisov/Modest/blob/master/LICENSE)
* lexbor engine — [Apache-2.0 license](https://github.com/lexbor/lexbor?tab=Apache-2.0-1-ov-file#readme)
* selectolax - [MIT](https://github.com/rushter/selectolax/blob/master/LICENSE)


## Contributors

Thanks to all the contributors of selectolax!

<a href="https://github.com/rushter/selectolax/graphs/contributors">
<img src="https://contrib.rocks/image?repo=rushter/selectolax" />
</a>
3 changes: 2 additions & 1 deletion docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
selectolax
==========

Selectolax is a fast HTML5 parser with CSS selectors.
Selectolax is a fast HTML5 parser with CSS selectors, written in Cython,
using [Modest](https://github.com/lexborisov/Modest/) and [Lexbor](https://github.com/lexbor/lexbor) engines.

It supports two backends:

Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ requires = [
[project]
name = 'selectolax'
version = '0.4.3'
description = 'Fast HTML5 parser with CSS selectors.'
description = 'A fast HTML5 parser with CSS selectors, written in Cython, using Modest and Lexbor engines.'
readme = 'README.md'
requires-python = '>=3.9,<3.15'
license = 'MIT'
Expand Down
2 changes: 1 addition & 1 deletion setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ def make_extensions():
setup(
name="selectolax",
version="0.4.3",
description="Fast HTML5 parser with CSS selectors.",
description="A fast HTML5 parser with CSS selectors, written in Cython, using Modest and Lexbor engines.",
long_description=readme,
author="Artem Golubin",
author_email="me@rushter.com",
Expand Down