Skip to content
Merged
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
15 changes: 7 additions & 8 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,18 +19,17 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v4
- uses: actions/setup-python@v5
with:
python-version: '3.11'

- name: Install Poetry
uses: snok/install-poetry@v1
- name: Install uv
uses: astral-sh/setup-uv@v5
with:
virtualenvs-create: false
virtualenvs-in-project: true
installer-parallel: true
- name: Install project
run: poetry install --no-interaction
enable-cache: true
cache-dependency-glob: "uv.lock"
- name: Install the project
run: uv sync --all-extras --dev
- run: pdoc -o docs/ redlines
- uses: actions/upload-pages-artifact@v2
with:
Expand Down
21 changes: 9 additions & 12 deletions .github/workflows/python-package.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,22 +19,19 @@ jobs:
python-version: [ "3.8", "3.9", "3.10", "3.11", "3.12" ]

steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v3
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
- name: Install Poetry
uses: snok/install-poetry@v1
- name: Install uv
uses: astral-sh/setup-uv@v5
with:
virtualenvs-create: true
virtualenvs-in-project: true
installer-parallel: true
- name: Install dependencies
run: poetry install --no-interaction --no-root
- name: Install project
run: poetry install --no-interaction
enable-cache: true
cache-dependency-glob: "uv.lock"
- name: Install the project
run: uv sync --all-extras --dev
- name: Test with pytest
run: |
source .venv/bin/activate
pytest
uv run pytest
10 changes: 5 additions & 5 deletions .github/workflows/python-publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,17 +21,17 @@ jobs:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v3
uses: actions/setup-python@v5
with:
python-version: '3.x'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install build
uv python -m pip install --upgrade pip
uv pip install build
- name: Build package
run: python -m build
run: uv python -m build
- name: Publish package
uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
with:
Expand Down
15 changes: 5 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ community looks forward to your contributions. 🎉
This project and everyone participating in it is governed by the
[CONTRIBUTING.md Code of Conduct](Code_of_Conduct.md).
By participating, you are expected to uphold this code. Please report unacceptable behavior
to <houfu@lovelawrobots.com>.
to <houfu@OUTLOOK dot sg>.

## I Have a Question

Expand All @@ -45,7 +45,7 @@ search the internet for answers first.

If you then still feel the need to ask a question and need clarification, we recommend the following:

- Open an [Issue](/issues/new) or join the [Matrix Chat](https://matrix.to/#/#redlines:matrix.esq.social).
- Open an [Issue](/issues/new).
- Provide as much context as you can about what you're running into.
- Provide project and platform versions (python version, platform like streamlit, colab etc), depending on what seems
relevant.
Expand Down Expand Up @@ -81,13 +81,11 @@ following steps in advance to help us fix any potential bug as fast as possible.
- Possibly your input and the output
- Can you reliably reproduce the issue? And can you also reproduce it with older versions?

You can join the project's [matrix room](https://chat.matrix.esq.social/#/room/#redlines:matrix.esq.social) to ask about
anything or get guidance.

#### How Do I Submit a Good Bug Report?

> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue
> tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to <houfu@lovelawrobots.com>.
> tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to <houfu@OUTLOOK dot sg>.


We use GitHub issues to track bugs and errors. If you run into an issue with the project:
Expand Down Expand Up @@ -144,8 +142,7 @@ Enhancement suggestions are tracked as [GitHub issues](/issues).

### Your First Code Contribution

Be relaxed and open to comments. Join the [Matrix Chat](https://matrix.to/#/#redlines:matrix.esq.social) to discuss or
get guidance.
Be relaxed and open to comments. We are all here to learn and grow together.

### Improving The Documentation

Expand All @@ -170,10 +167,8 @@ It's helpful to use a "verb" (like add, fix etc) and a short description of what

## Join The Project Team

Please [email me](mailto:houfu@lovelawrobots.com) or file an [issue](/issues).
Please [email me](mailto:houfu@OUTLOOK dot sg) or file an [issue](/issues).

You can test the waters by joining the [Matrix Chat](https://matrix.to/#/#redlines:matrix.esq.social) and letting us
know what you think.

## Attribution

Expand Down
2 changes: 1 addition & 1 deletion Code_of_Conduct.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Examples of unacceptable behaviour by participants include:
## Enforcement

Violations of the Code of Conduct may be reported by sending an email
to [houfu@lovelawrobots.com](mailto:houfu@lovelawrobots.com).
to [houfu@OUTLOOK dot sg](mailto:houfu@outlook.sg).
All reports will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to
the circumstances. Further details of specific enforcement policies may be posted separately.

Expand Down
2 changes: 1 addition & 1 deletion LICENSE.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2022 Ang Hou Fu
Copyright (c) 2022-2025 Ang Hou Fu and contributors

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
![GitHub Release Date - Published_At](https://img.shields.io/github/release-date/houfu/redlines)
![GitHub last commit (by committer)](https://img.shields.io/github/last-commit/houfu/redlines)
![PyPI - License](https://img.shields.io/pypi/l/redlines)
[![Chat on Matrix](https://matrix.to/img/matrix-badge.svg)](https://matrix.to/#/#redlines:matrix.esq.social)

`Redlines` produces a text showing the differences between two strings/text. The changes are represented with
strike-throughs and underlines, which looks similar to Microsoft Word's track changes. This method of showing changes is
Expand Down
57 changes: 18 additions & 39 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,51 +3,30 @@ name = "redlines"
version = "0.5.1"
description = "Compare text, and produce human-readable differences or deltas which look like track changes in Microsoft Word."
readme = "README.md"
dependencies = [
"click>=8.1.7",
"rich-click>=1.8.3",
"rich>=13.9.1",
authors = [
{ name = "houfu", email = "houfu@outlook.sg" }
]
license = { text = "MIT" }
requires-python = ">=3.8"

[tool.uv]
dev-dependencies = [
"pdoc>=14.7.0",
"pytest>=8.3.3",
"pytest-cov>=5.0.0",
"pytest-sugar>=1.0.0",
"tox>=4.21.0",
dependencies = [
"click>=8.1.7",
"rich-click>=1.6.1",
"rich>=13.3.5",
]
urls = { homepage = "https://houfu.github.io/redlines/", repository = "https://github.com/houfu/redlines" }

[project.scripts]
redlines = 'redlines.cli:cli'

[tool.poetry]
name = "redlines"
version = "0.5.1"
description = "Compare text, and produce human-readable differences or deltas which look like track changes in Microsoft Word."
authors = ["houfu <houfu@outlook.sg>"]
license = "MIT"
readme = "README.md"
homepage = "https://houfu.github.io/redlines/"
repository = "https://github.com/houfu/redlines"

[tool.poetry.dependencies]
python = "<4.0,>=3.8"
rich = "^13.3.5"
click = "^8.1.3"
rich-click = "^1.6.1"

[tool.poetry.dev-dependencies]
pytest = "^7.0.1"
pytest-sugar = "^0.9.4"
pytest-cov = "^3.0.0"
tox = "^3.24.5"
pdoc = "^14.1.0"
[tool.uv]
dev-dependencies = [
"pdoc>=14.1.0",
"pytest>=7.4.2",
"pytest-cov>=3.0.0",
"pytest-sugar>=0.9.7",
"tox>=3.28.0",
]

[build-system]
requires = ["poetry-core>=1.0.0"]
build-backend = "poetry.core.masonry.api"

[tool.poetry.scripts]
redlines = 'redlines.cli:cli'
requires = ["hatchling>=1.18.0"]
build-backend = "hatchling.build"
Loading