Modernize project

.github/workflows/ci.yml

@@ -0,0 +1,29 @@
+name: CI
+
+on:
+  push:
+    branches: [dev, main, master]
+  pull_request:
+    branches: [dev, main, master]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: uv sync --python ${{ matrix.python-version }}
+
+      - name: Run tests
+        run: uv run pytest --cov-report term-missing --cov=tldr/ -vs tests/

pyproject.toml

@@ -0,0 +1,48 @@
+[project]
+name = "tldr.py"
+version = "0.8.0"
+description = "A python client for tldr: simplified and community-driven man pages."
+readme = "README.rst"
+license = "MIT"
+authors = [
+    { name = "lord63", email = "lord63.j@gmail.com" },
+]
+requires-python = ">=3.10"
+keywords = ["tldr", "cli", "man", "command", "usage"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Operating System :: POSIX",
+    "Operating System :: POSIX :: Linux",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+]
+dependencies = [
+    "click>=8.0",
+    "PyYAML>=6.0",
+]
+
+[project.scripts]
+tldr = "tldr.cli:cli"
+
+[project.urls]
+Homepage = "https://github.com/lord63/tldr.py"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["tldr"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[dependency-groups]
+dev = [
+    "pytest>=8.0",
+    "pytest-cov>=5.0",
+]

tests/basic.py

@@ -1,5 +1,4 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*-
 
 import os
 from os import path

tests/test_config.py

@@ -1,5 +1,4 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*-
 
 from unittest import mock
 
@@ -16,7 +15,7 @@ def test_config_not_exist(self):
             )
 
     def test_invalid_yaml_file(self):
-        with mock.patch('io.open',
+        with mock.patch('builtins.open',
                         mock.mock_open(read_data="%YAML:1.0\nname:jhon")):
             self._assert_exception_message(
                 "The config file is not a valid YAML file."

tests/test_find.py

@@ -1,7 +1,4 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*-
-
-from __future__ import absolute_import
 
 from basic import BasicTestCase
 

tests/test_init.py

@@ -1,9 +1,5 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*-
 
-from __future__ import absolute_import
-
-import io
 import os
 from os import path
 
@@ -25,7 +21,7 @@ def test_init(self):
             'platform': 'linux',
             'repo_directory': self.repo_dir
         }
-        with io.open(self.config_path, encoding='utf-8') as f:
+        with open(self.config_path, encoding='utf-8') as f:
             config = yaml.safe_load(f)
         assert expected_config == config
 

tests/test_list.py

@@ -1,7 +1,4 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*-
-
-from __future__ import absolute_import
 
 from basic import BasicTestCase
 

tests/test_locate.py

@@ -1,7 +1,4 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*-
-
-from __future__ import absolute_import
 
 from os import path
 

tests/test_parse.py

@@ -1,5 +1,4 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*-
 
 import unittest
 from unittest import mock
@@ -51,6 +50,6 @@ def _assert_mock_read(self, page_content):
             '\x1b[0m\n\x1b[0m'
         )
         with mock.patch('tldr.parser.get_config', return_value=mock_config):
-            with mock.patch('io.open', mock.mock_open(read_data=page_content)):
+            with mock.patch('builtins.open', mock.mock_open(read_data=page_content)):
                 result = parse_page('/repo_directory/pages/common/node.md')
                 assert ''.join(result) == expected_result

tests/test_reindex.py

@@ -1,7 +1,4 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*-
-
-from __future__ import absolute_import
 
 import os
 from os import path
@@ -12,7 +9,7 @@
 
 class TestReindex(BasicTestCase):
     def setUp(self):
-        super(TestReindex, self).setUp()
+        super().setUp()
 
         # Add a new page.
         self.page_path = path.join(self.repo_dir, 'pages')
@@ -25,7 +22,7 @@ def setUp(self):
                     path.join(self.page_path, 'index_bak.json'))
 
     def tearDown(self):
-        super(TestReindex, self).tearDown()
+        super().tearDown()
         if path.exists(self.new_page):
             os.remove(self.new_page)
         # Restore the index.json.

tests/test_update.py

@@ -1,5 +1,4 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*-
 
 from unittest import mock
 

tldr/__init__.py

@@ -1,5 +1,4 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*-
 
 """
     tldr.py

tldr/cli.py

@@ -1,9 +1,5 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*-
 
-from __future__ import absolute_import
-
-import io
 import json
 from operator import itemgetter
 import os
@@ -29,8 +25,8 @@ def parse_man_page(command, platform):
 def get_index():
     """Retrieve index in the pages directory."""
     repo_directory = get_config()['repo_directory']
-    with io.open(path.join(repo_directory, 'pages/index.json'),
-                 encoding='utf-8') as f:
+    with open(path.join(repo_directory, 'pages/index.json'),
+              encoding='utf-8') as f:
         index = json.load(f)
     return index
 

tldr/config.py

@@ -1,9 +1,5 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*-
 
-from __future__ import absolute_import
-
-import io
 import os
 from os import path
 import sys
@@ -21,7 +17,7 @@ def get_config():
         sys.exit("Can't find config file at: {0}. You may use `tldr init` "
                  "to init the config file.".format(config_path))
 
-    with io.open(config_path, encoding='utf-8') as f:
+    with open(config_path, encoding='utf-8') as f:
         try:
             config = yaml.safe_load(f)
         except yaml.scanner.ScannerError:

tldr/parser.py

@@ -1,9 +1,5 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*-
 
-from __future__ import absolute_import
-
-import io
 import click
 
 from tldr.config import get_config
@@ -12,7 +8,7 @@
 def parse_page(page):
     """Parse the command man page."""
     colors = get_config()['colors']
-    with io.open(page, encoding='utf-8') as f:
+    with open(page, encoding='utf-8') as f:
         lines = f.readlines()
     output_lines = []
     for line in lines[1:]: