Merge pull request #81 from aleivag/semifull.pyproject.toml

Adding semi-full support for pyproyect.toml

Author: aleivag

.github/workflows/ci.yml

@@ -17,19 +17,12 @@ jobs:
       uses: actions/setup-python@v2
       with:
         python-version: ${{ matrix.python }}
-    - name: Setup Cython
-      run: |
-        pip install -r requirements.txt Cython
-        pip install Cython
     - name: Install dependencies
       run: sudo apt-get install -y libsystemd-dev
-    - name: Build pystemd
-      run: python setup.py sdist
     - name: Install pystemd
-      run: pip install dist/pystemd*.tar.gz
+      run: pip install -e '.[t]'
     - name: Run unit tests
-      run: python -m unittest discover
-      working-directory: ./tests
+      run: pytest --cov=pystemd tests
 
   formatting:
     runs-on: ubuntu-latest
@@ -40,8 +33,7 @@ jobs:
       uses: psf/black@stable
     - name: Run isort
       uses: isort/isort-action@v1
-      with:
-        sort-paths: "pystemd"
+
 
   typing:
     runs-on: ubuntu-latest

.gitignore

@@ -42,6 +42,9 @@ tmtagsHistory
 
 # Distribution / packaging
 .Python
+.pytest_cache/
+.mypy_cache/
+.coverage
 env/
 build/
 develop-eggs/

README.md

@@ -14,16 +14,17 @@ and then parsing the output to know the result.
 Show don't tell
 ---------------
 
-In software as in screenwriting, its better to show how things work instead of
+In software as in screenwriting, it's better to show how things work instead of
 tell. So this is how you would use the library from a interactive shell.
 
     In [1]: from pystemd.systemd1 import Unit
     In [2]: unit = Unit(b'postfix.service')
     In [3]: unit.load()
 
 Note: you need to call `unit.load()` because by default `Unit` will not load the
-unit information as that would require do some IO. You can auto load the unit by
-`Unit(b'postfix.service', _autoload=True)`
+unit information as that would require do some IO (and we dont like doing io on a class constructor). 
+You can autoload the unit by `Unit(b'postfix.service', _autoload=True)` or using the unit as a 
+contextmanager like `with Unit(b'postfix.service'): ...`
 
 Once the unit is loaded, you can interact with it, you can do by accessing its
 systemd's interfaces:
@@ -246,14 +247,10 @@ v237.
 * gcc: or any compiler that `setup.py` will accept.
 * [`pkg-config`](https://www.freedesktop.org/wiki/Software/pkg-config/) command. Depending on your distro, the package is called "pkg-config", "pkgconfig" or a compatible substitute like "pkgconf"
 
-if you want to install from source then after you clone this repo you need to
+if you want to install from source then after you clone this repo all you need to do its `pip install . `
 
-```bash
-$ pip install -r requirements.txt # get six
-$ python3 setup.py install # only python3 supported
-```
 
-but in addition to previous requirements you'll need:
+In addition to previous requirements you'll need:
 
   * setuptools: Just use your distro's package (e.g. python-setuptools).
   * Cython: at least version 0.21a1, just pip install it or use the official

examples/future_cpucap_pool.py

@@ -5,7 +5,6 @@
 from threading import Thread
 
 import psutil
-
 from psutil import NoSuchProcess
 
 from pystemd.futures import TransientUnitPoolExecutor

examples/future_cpucap_process.py

@@ -4,6 +4,7 @@
 
 import psutil
 from psutil import NoSuchProcess
+
 from pystemd.futures import TransientUnitProcess
 
 

examples/monitor.py

@@ -10,7 +10,7 @@
 from itertools import chain
 from pprint import pprint
 
-from pystemd.dbuslib import apply_signature, DBus
+from pystemd.dbuslib import DBus, apply_signature
 
 
 def monitor(*args):

examples/shell.py

@@ -18,12 +18,12 @@
 import sys
 from pathlib import Path
 
+from IPython.terminal.embed import InteractiveShellEmbed
+
 import pystemd
 import pystemd.daemon
 import pystemd.journal
 import pystemd.run
-from IPython.terminal.embed import InteractiveShellEmbed
-
 
 display_banner = """
 Welcome to pystemd  {pystemd.__version__} interactive shell for python {sys.version}.

pyproject.toml

@@ -1,3 +1,53 @@
+[build-system]
+requires = ["setuptools>=46.4.0", "wheel", "cython"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pystemd"
+version = "0.13.0"
+readme = "README.md"
+description="A systemd binding for python"
+dependencies = [
+    "lxml",
+    "psutil"
+]
+authors = [{name = "Alvaro Leiva Geisse", email = "aleivag@gmail.com"}]
+maintainers = [
+    {name = "Alvaro Leiva Geisse", email = "aleivag@gmail.com"},
+    {name = "Davide Cavalca", email = "dcavalca@meta.com"},
+    {name = "Anita Zhang", email = "the.anitazha@gmail.com"}
+]
+classifiers = [
+    "Operating System :: POSIX :: Linux",
+    "Intended Audience :: Developers",
+    "Intended Audience :: System Administrators",
+    "Programming Language :: Python :: 3.6",
+    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Development Status :: 5 - Production/Stable",
+    "Topic :: Utilities",
+    "License :: OSI Approved :: GNU Lesser General Public License v2 or later (LGPLv2+)",
+]
+license = { text = "LGPL-2.1+" }
+keywords = ["systemd", "linux", "dbus"]
+
+[project.optional-dependencies]
+# Used for runing tests
+t = ["pytest", "pytest-cov"]
+lint = [
+    "black",
+    "mypi",
+    "isort",
+]
+
+[project.urls]
+changelog = "https://github.com/systemd/pystemd/blob/main/CHANGES.md"
+homepage = "https://github.com/systemd/pystemd"
+repository = "https://github.com/systemd/pystemd.git"
+
 [tool.mypy]
 strict = false
 packages = ["pystemd"]

requirements.txt

@@ -8,7 +8,6 @@
 #
 
 
-import ast
 import glob
 import subprocess
 import sys
@@ -36,25 +35,6 @@
 except ValueError:
     sys.exit("libsystemd version returned by pkg-config is not a plain integer!")
 
-THIS_DIR = Path(__file__).parent
-
-with (THIS_DIR / "README.md").open() as f:
-    long_description = f.read()
-
-# get and compute the version string
-version_file = THIS_DIR / "pystemd" / "__version__.py"
-with version_file.open() as f:
-    parsed_file = ast.parse(f.read())
-
-__version__ = [
-    expr.value.s
-    for expr in parsed_file.body
-    if isinstance(expr, ast.Assign)
-    and isinstance(expr.targets[0], ast.Name)
-    and isinstance(expr.value, ast.Str)
-    and expr.targets[0].id == "__version__"
-][0]
-
 # Use C extensions if respective files are present. Else let Cython modules be
 # compiled to C code. The latter is the case when using a clone of the git
 # repository, unlike the source distribution which includes both .pyx and .c
@@ -80,42 +60,17 @@
         else:
             raise RuntimeError("Cython not installed.")
 
-package_data = []
-package_data.extend(glob.glob("pystemd/*.pyi"))
-package_data.extend(glob.glob("pystemd/*/*.pyi"))
 
 setup(
     name="pystemd",
-    version=__version__,
+    version="0.13.0",
+    author="Alvaro Leiva Geisse",
+    author_email="aleivag@gmail.com",
     packages=["pystemd", "pystemd.systemd1", "pystemd.machine1", "pystemd.DBus"],
-    author="Alvaro Leiva",
-    author_email="aleivag@meta.com",
     ext_modules=external_modules,
-    url="https://github.com/systemd/pystemd",
-    classifiers=[
-        "Operating System :: POSIX :: Linux",
-        "Intended Audience :: Developers",
-        "Intended Audience :: System Administrators",
-        "Programming Language :: Python :: 3.6",
-        "Programming Language :: Python :: 3.7",
-        "Programming Language :: Python :: 3.8",
-        "Programming Language :: Python :: 3.9",
-        "Programming Language :: Python :: 3.10",
-        "Programming Language :: Python :: 3.11",
-        "Development Status :: 5 - Production/Stable",
-        "Topic :: Utilities",
-        "License :: OSI Approved :: GNU Lesser General Public License v2 or later (LGPLv2+)",
-    ],
-    keywords=["systemd"],
-    description="A systemd binding for python",
     package_data={
-        "pystemd": [str(Path(p).relative_to("pystemd")) for p in package_data]
+        "pystemd": [
+            str(Path(p).relative_to("pystemd")) for p in glob.glob("pystemd/**/*.pyi")
+        ]
     },
-    install_requires=[
-        "lxml",
-        "psutil",
-    ],
-    long_description=long_description,
-    long_description_content_type="text/markdown",
-    license="LGPL-2.1+",
 )