Merge branch 'dev'

Author: gershnik

.github/workflows/test.yml

@@ -12,6 +12,7 @@ on:
       - 'CHANGELOG.md'
       - '.github/workflows/release.yml'
       - '.github/workflows/docs.yml'
+      - 'docs'
 
 jobs:
   matrix:

.pylintrc

@@ -0,0 +1,20 @@
+[MAIN]
+ignore=src/repopulator/rpmfile
+
+[MESSAGES CONTROL]
+
+disable=protected-access, 
+        wrong-import-order, 
+        trailing-whitespace, 
+        trailing-newlines, 
+        line-too-long, 
+        multiple-statements,
+        consider-using-enumerate,
+        too-few-public-methods,
+        too-many-locals,
+        too-many-branches,
+        too-many-return-statements,
+        too-many-instance-attributes,
+        too-many-arguments,
+        too-many-statements,
+        R0801  #Similar lines in 2 files

CHANGELOG.md

@@ -5,6 +5,13 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ## Unreleased
 
+### Added
+- CRUD for all repo-related objects
+
+### Fixed
+- PgpSigner now respects home directory parameter
+- Project is now Stable
+
 ## [0.7] - 2024-06-05
 
 ### Changed

README.md

@@ -55,12 +55,11 @@ Currently repositories are required to be signed and you need to provide signing
 
 ```python
 from repopulator import AptRepo, PgpSigner
-from pathlib import Path
 
 repo = AptRepo()
 
-package1 = repo.add_package(Path('/path/to/awesome_3.14_amd64.deb'))
-package2 = repo.add_package(Path('/path/to/awesome_3.14_arm64.deb'))
+package1 = repo.add_package('/path/to/awesome_3.14_amd64.deb')
+package2 = repo.add_package('/path/to/awesome_3.14_arm64.deb')
 
 dist = repo.add_distribution('jammy', 
                              origin='my packages', 
@@ -69,80 +68,76 @@ dist = repo.add_distribution('jammy',
                              version='1.2', 
                              description='my awesome repo')
 
-dist.add_package(component='main', package=package1)
-dist.add_package(component='main', package=package2)
+repo.assign_package(package1, dist, component='main')
+repo.assign_package(package2, dist, component='main')
 
-signer = PgpSigner(Path.home() / '.gnupg', 'name_of_key_to_use', 'password_of_that_key')
+signer = PgpSigner('name_of_key_to_use', 'password_of_that_key')
 
-repo.export(Path('/path/of/new/repo'), signer)
+repo.export('/path/of/new/repo', signer)
 
 ```
 
-#### YUM/DNF
+#### RPM
 
 ```python
 from repopulator import RpmRepo, PgpSigner
-from pathlib import Path
 
 repo = RpmRepo()
-repo.add_package(Path('/path/to/awesome-3.14-1.el9.x86_64.rpm'))
-repo.add_package(Path('/path/to/awesome-3.14-1.el9.aarch64.rpm'))
+repo.add_package('/path/to/awesome-3.14-1.el9.x86_64.rpm')
+repo.add_package('/path/to/awesome-3.14-1.el9.aarch64.rpm')
 
-signer = PgpSigner(Path.home() / '.gnupg', 'name_of_key_to_use', 'password_of_that_key')
+signer = PgpSigner('name_of_key_to_use', 'password_of_that_key')
 
-repo.export(Path('/path/of/new/repo'), signer)
+repo.export('/path/of/new/repo', signer)
 
 ```
 
 #### Pacman
 
 ```python
 from repopulator import PacmanRepo, PgpSigner
-from pathlib import Path
 
 repo = PacmanRepo('myrepo')
 # if .sig file is present next to the .zst file it will be used for signature
 # otherwise new signature will be generated at export time
-repo.add_package(Path('/path/to/awesome-3.14-1-x86_64.pkg.tar.zst'))
+repo.add_package('/path/to/awesome-3.14-1-x86_64.pkg.tar.zst')
+repo.add_package('/path/to/another-1.2-1-x86_64.pkg.tar.zst')
 
-signer = PgpSigner(Path.home() / '.gnupg', 'name_of_key_to_use', 'password_of_that_key')
+signer = PgpSigner('name_of_key_to_use', 'password_of_that_key')
 
-repo.export(Path('/path/of/new/repo'), signer)
+repo.export('/path/of/new/repo', signer)
 
 ```
 
 #### Alpine apk
 
 ```python
-from repopulator import PacmanRepo, PkiSigner
-from pathlib import Path
+from repopulator import AlpineRepo, PkiSigner
 
-repo = PacmanRepo('my repo description')
-repo.add_package(Path('/path/to/awesome-3.14-r0.apk'))
-repo.add_package(Path('/path/to/another-1.23-r0.apk'))
+repo = AlpineRepo('my repo description')
+repo.add_package('/path/to/awesome-3.14-r0.apk')
+repo.add_package('/path/to/another-1.23-r0.apk')
 
-signer = PkiSigner(Path('/path/to/private/key'), 'password_or_None')
+signer = PkiSigner('/path/to/private/key', 'password_or_None')
 
-# The last argument is the 'name' of the signer to use
-# Unlike `pkg` tool we do not parse it out of private key filename
-# and do not require you to name key files in certain way
-repo.export(Path('/path/of/new/repo'), signer, '[email protected]')
+# Unlike `pkg` tool we do not parse signer name out of private key filename
+# so you can name your key files whatever you wish
+repo.export('/path/of/new/repo', signer, signer_name = '[email protected]')
 
 ```
 
 #### FreeBSD pkg
 
 ```python
 from repopulator import FreeBSDRepo, PkiSigner
-from pathlib import Path
 
 repo = FreeBSDRepo()
-repo.add_package(Path('/path/to/awesome-3.14.pkg'))
-repo.add_package(Path('/path/to/another-1.2.pkg'))
+repo.add_package('/path/to/awesome-3.14.pkg')
+repo.add_package('/path/to/another-1.2.pkg')
 
-signer = PkiSigner(Path('/path/to/private/key'), 'password_or_None')
+signer = PkiSigner('/path/to/private/key', 'password_or_None')
 
-repo.export(Path('/path/of/new/repo'), signer)
+repo.export('/path/of/new/repo', signer)
 
 ```
 

mkdocs.yml

@@ -18,6 +18,8 @@ plugins:
       default_handler: python
       handlers:
         python:
+          import:
+            - https://docs.python.org/3/objects.inv
           options:
             paths: [src]
             docstring_style: google

pyproject.toml

@@ -13,7 +13,7 @@ where = ["src"]
 [project]
 name = "repopulator"
 dynamic = ["version"]
-description="Portably create software repositories for different operating systems"
+description="A portable library to generate binary software repositories"
 readme="README.md"
 authors= [
     { name = 'Eugene Gershnik', email='[email protected]'}
@@ -31,14 +31,12 @@ keywords = [
 ]
 license = {text = "BSD-3-Clause"}
 classifiers = [
-    "Development Status :: 4 - Beta",
+    "Development Status :: 5 - Production/Stable",
 
     "License :: OSI Approved :: BSD License",
 
     "Operating System :: OS Independent",
 
-    "Environment :: Console",
-
     "Intended Audience :: Developers",
     "Intended Audience :: System Administrators",
 

requirements.txt requirements-dev.txt

@@ -4,4 +4,4 @@ build
 twine
 pytest
 python-dotenv
-
+pylint