quickpub 4.1.1__tar.gz → 4.1.3__tar.gz

quickpub-4.1.3/PKG-INFO

@@ -0,0 +1,246 @@
+Metadata-Version: 2.4
+Name: quickpub
+Version: 4.1.3
+Summary: A local CI/CD simulation tool that runs quality checks, tests, and validations locally before publishing Python packages, ensuring higher build pass rates and faster feedback loops
+Author-email: danielnachumdev <danielnachumdev@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2022 danielnachumdev
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+Project-URL: Homepage, https://github.com/danielnachumdev/quickpub
+Project-URL: Bug Tracker, https://github.com/danielnachumdev/quickpub/issues
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Typing :: Typed
+Requires-Python: >=3.8.0
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: danielutils>=1.1.23
+Requires-Dist: requests
+Requires-Dist: fire
+Requires-Dist: twine
+Dynamic: license-file
+
+# QuickPub
+
+[![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
+
+Catch publish failures on your machine before they hit CI or PyPI.
+
+QuickPub runs pre-publish checks, quality tools, tests, packaging, and upload in one pipeline — so broken releases fail locally with fast feedback.
+
+## The problem
+
+Publishing a Python package usually means juggling several steps: validate project files, run mypy/pylint/pytest, bump the version, generate packaging files, build the sdist, upload to PyPI. Miss a step and you find out in CI — or worse, after a bad release.
+
+QuickPub wires those steps together. You define your package once; it enforces constraints, runs QA across Python environments, builds, and uploads.
+
+## Install
+
+```bash
+pip install quickpub
+```
+
+With [uv](https://docs.astral.sh/uv/):
+
+```bash
+uv add quickpub
+```
+
+Requires Python **3.8+** (tested on 3.8–3.13).
+
+## Quick start
+
+Add a `publish.py` in your project root:
+
+```python
+from quickpub import (
+    publish,
+    MypyRunner,
+    PylintRunner,
+    PytestRunner,
+    SetuptoolsBuildSchema,
+    PypircUploadTarget,
+    PypircEnforcer,
+    ReadmeEnforcer,
+    LicenseEnforcer,
+    LocalVersionEnforcer,
+    PypiRemoteVersionEnforcer,
+)
+
+publish(
+    name="my-package",
+    version="1.0.0",
+    author="Your Name",
+    author_email="you@example.com",
+    description="My package",
+    homepage="https://github.com/you/my-package",
+    dependencies=["requests>=2.25.0"],
+    min_python="3.8.0",
+    enforcers=[
+        PypircEnforcer(),
+        ReadmeEnforcer(),
+        LicenseEnforcer(),
+        LocalVersionEnforcer(),
+        PypiRemoteVersionEnforcer(),
+    ],
+    global_quality_assurance_runners=[
+        MypyRunner(bound="<=20"),
+        PylintRunner(bound=">=0.8"),
+        PytestRunner(bound=">=0.95"),
+    ],
+    build_schemas=[SetuptoolsBuildSchema()],
+    upload_targets=[PypircUploadTarget()],
+)
+```
+
+### uv / `pyproject.toml` projects (important)
+
+If the project already has a PEP 621 `pyproject.toml` (uv, Hatch, Poetry, PDM), **do not** use the default file generation. `publish()` would overwrite `pyproject.toml` and wipe `[dependency-groups]`, `[tool.uv]`, `[tool.mypy]`, and other toolchain config.
+
+Use `UvBuildSchema` and `generate_project_files=False`:
+
+```python
+from quickpub import (
+    publish,
+    UvBuildSchema,
+    PypircUploadTarget,
+    PypircEnforcer,
+    ReadmeEnforcer,
+    LicenseEnforcer,
+    LocalVersionEnforcer,
+    PypiRemoteVersionEnforcer,
+    MypyRunner,
+    PylintRunner,
+    PytestRunner,
+)
+
+publish(
+    name="my-package",
+    version="1.0.0",
+    author="Your Name",
+    author_email="you@example.com",
+    description="My package",
+    homepage="https://github.com/you/my-package",
+    dependencies=["requests>=2.25.0"],
+    min_python="3.8.0",
+    enforcers=[
+        PypircEnforcer(),
+        ReadmeEnforcer(),
+        LicenseEnforcer(),
+        LocalVersionEnforcer(),
+        PypiRemoteVersionEnforcer(),
+    ],
+    global_quality_assurance_runners=[
+        MypyRunner(bound="<=20"),
+        PylintRunner(bound=">=0.8"),
+        PytestRunner(bound=">=0.95"),
+    ],
+    build_schemas=[UvBuildSchema()],
+    generate_project_files=False,
+    upload_targets=[PypircUploadTarget()],
+)
+```
+
+That keeps the existing `pyproject.toml`, bumps only `[project].version` and `__init__.__version__`, and builds with `uv build`. See [this repo's `publish.py`](publish.py).
+
+Run it:
+
+```bash
+python publish.py
+```
+
+**Dry run** — validate and run QA without building or uploading:
+
+```python
+publish(..., demo=True)
+```
+
+PyPI upload needs a valid `.pypirc`. See [this repo's `publish.py`](publish.py) for a full working example.
+
+## What runs
+
+When you call `publish()`, QuickPub runs these stages in order:
+
+1. **Enforcers** — checks README, LICENSE, `.pypirc`, and local/PyPI version consistency
+2. **Quality assurance** — mypy, pylint, pytest, and unittest with configurable score bounds, in parallel across detected Python environments
+3. **File generation** — by default writes `setup.py`, `pyproject.toml`, `MANIFEST.in`, and updates `__init__.py`. Pass `generate_project_files=False` to keep an existing `pyproject.toml` (only `[project].version` and `__init__.__version__` are updated).
+4. **Build & upload** — builds the sdist (`SetuptoolsBuildSchema` or `UvBuildSchema`) and uploads via twine (and optionally pushes to GitHub)
+
+Skip build and upload with `demo=True`.
+
+## Environment detection
+
+By default, QuickPub detects your toolchain from the project root:
+
+| Project layout | Package manager | Python provider |
+|---|---|---|
+| `uv.lock` present | `UvPackageManager` | `UvPythonProvider` |
+| otherwise | `PipPackageManager` | `DefaultPythonProvider` |
+
+Override for conda or mixed setups:
+
+```python
+from quickpub import CondaPythonProvider, UnionProvider
+
+publish(
+    ...,
+    python_interpreter_provider=UnionProvider([
+        CondaPythonProvider(["base", "py39", "py38"]),
+    ]),
+)
+```
+
+For full control, pass `package_manager` and `python_interpreter_provider` explicitly, or call `resolve_publish_environment()` before `publish()`.
+
+## CLI
+
+QuickPub installs a `quickpub` command that wraps `publish()` via [Fire](https://github.com/google/python-fire). For most projects, a `publish.py` script is easier to maintain than long CLI invocations.
+
+## Development
+
+To work on QuickPub itself, clone the repo and use uv:
+
+```bash
+git clone https://github.com/danielnachumdev/quickpub.git
+cd quickpub
+uv sync
+uv run pytest
+```
+
+## License
+
+MIT — see [LICENSE](LICENSE).

quickpub-4.1.3/README.md

@@ -0,0 +1,191 @@
+# QuickPub
+
+[![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
+
+Catch publish failures on your machine before they hit CI or PyPI.
+
+QuickPub runs pre-publish checks, quality tools, tests, packaging, and upload in one pipeline — so broken releases fail locally with fast feedback.
+
+## The problem
+
+Publishing a Python package usually means juggling several steps: validate project files, run mypy/pylint/pytest, bump the version, generate packaging files, build the sdist, upload to PyPI. Miss a step and you find out in CI — or worse, after a bad release.
+
+QuickPub wires those steps together. You define your package once; it enforces constraints, runs QA across Python environments, builds, and uploads.
+
+## Install
+
+```bash
+pip install quickpub
+```
+
+With [uv](https://docs.astral.sh/uv/):
+
+```bash
+uv add quickpub
+```
+
+Requires Python **3.8+** (tested on 3.8–3.13).
+
+## Quick start
+
+Add a `publish.py` in your project root:
+
+```python
+from quickpub import (
+    publish,
+    MypyRunner,
+    PylintRunner,
+    PytestRunner,
+    SetuptoolsBuildSchema,
+    PypircUploadTarget,
+    PypircEnforcer,
+    ReadmeEnforcer,
+    LicenseEnforcer,
+    LocalVersionEnforcer,
+    PypiRemoteVersionEnforcer,
+)
+
+publish(
+    name="my-package",
+    version="1.0.0",
+    author="Your Name",
+    author_email="you@example.com",
+    description="My package",
+    homepage="https://github.com/you/my-package",
+    dependencies=["requests>=2.25.0"],
+    min_python="3.8.0",
+    enforcers=[
+        PypircEnforcer(),
+        ReadmeEnforcer(),
+        LicenseEnforcer(),
+        LocalVersionEnforcer(),
+        PypiRemoteVersionEnforcer(),
+    ],
+    global_quality_assurance_runners=[
+        MypyRunner(bound="<=20"),
+        PylintRunner(bound=">=0.8"),
+        PytestRunner(bound=">=0.95"),
+    ],
+    build_schemas=[SetuptoolsBuildSchema()],
+    upload_targets=[PypircUploadTarget()],
+)
+```
+
+### uv / `pyproject.toml` projects (important)
+
+If the project already has a PEP 621 `pyproject.toml` (uv, Hatch, Poetry, PDM), **do not** use the default file generation. `publish()` would overwrite `pyproject.toml` and wipe `[dependency-groups]`, `[tool.uv]`, `[tool.mypy]`, and other toolchain config.
+
+Use `UvBuildSchema` and `generate_project_files=False`:
+
+```python
+from quickpub import (
+    publish,
+    UvBuildSchema,
+    PypircUploadTarget,
+    PypircEnforcer,
+    ReadmeEnforcer,
+    LicenseEnforcer,
+    LocalVersionEnforcer,
+    PypiRemoteVersionEnforcer,
+    MypyRunner,
+    PylintRunner,
+    PytestRunner,
+)
+
+publish(
+    name="my-package",
+    version="1.0.0",
+    author="Your Name",
+    author_email="you@example.com",
+    description="My package",
+    homepage="https://github.com/you/my-package",
+    dependencies=["requests>=2.25.0"],
+    min_python="3.8.0",
+    enforcers=[
+        PypircEnforcer(),
+        ReadmeEnforcer(),
+        LicenseEnforcer(),
+        LocalVersionEnforcer(),
+        PypiRemoteVersionEnforcer(),
+    ],
+    global_quality_assurance_runners=[
+        MypyRunner(bound="<=20"),
+        PylintRunner(bound=">=0.8"),
+        PytestRunner(bound=">=0.95"),
+    ],
+    build_schemas=[UvBuildSchema()],
+    generate_project_files=False,
+    upload_targets=[PypircUploadTarget()],
+)
+```
+
+That keeps the existing `pyproject.toml`, bumps only `[project].version` and `__init__.__version__`, and builds with `uv build`. See [this repo's `publish.py`](publish.py).
+
+Run it:
+
+```bash
+python publish.py
+```
+
+**Dry run** — validate and run QA without building or uploading:
+
+```python
+publish(..., demo=True)
+```
+
+PyPI upload needs a valid `.pypirc`. See [this repo's `publish.py`](publish.py) for a full working example.
+
+## What runs
+
+When you call `publish()`, QuickPub runs these stages in order:
+
+1. **Enforcers** — checks README, LICENSE, `.pypirc`, and local/PyPI version consistency
+2. **Quality assurance** — mypy, pylint, pytest, and unittest with configurable score bounds, in parallel across detected Python environments
+3. **File generation** — by default writes `setup.py`, `pyproject.toml`, `MANIFEST.in`, and updates `__init__.py`. Pass `generate_project_files=False` to keep an existing `pyproject.toml` (only `[project].version` and `__init__.__version__` are updated).
+4. **Build & upload** — builds the sdist (`SetuptoolsBuildSchema` or `UvBuildSchema`) and uploads via twine (and optionally pushes to GitHub)
+
+Skip build and upload with `demo=True`.
+
+## Environment detection
+
+By default, QuickPub detects your toolchain from the project root:
+
+| Project layout | Package manager | Python provider |
+|---|---|---|
+| `uv.lock` present | `UvPackageManager` | `UvPythonProvider` |
+| otherwise | `PipPackageManager` | `DefaultPythonProvider` |
+
+Override for conda or mixed setups:
+
+```python
+from quickpub import CondaPythonProvider, UnionProvider
+
+publish(
+    ...,
+    python_interpreter_provider=UnionProvider([
+        CondaPythonProvider(["base", "py39", "py38"]),
+    ]),
+)
+```
+
+For full control, pass `package_manager` and `python_interpreter_provider` explicitly, or call `resolve_publish_environment()` before `publish()`.
+
+## CLI
+
+QuickPub installs a `quickpub` command that wraps `publish()` via [Fire](https://github.com/google/python-fire). For most projects, a `publish.py` script is easier to maintain than long CLI invocations.
+
+## Development
+
+To work on QuickPub itself, clone the repo and use uv:
+
+```bash
+git clone https://github.com/danielnachumdev/quickpub.git
+cd quickpub
+uv sync
+uv run pytest
+```
+
+## License
+
+MIT — see [LICENSE](LICENSE).

quickpub-4.1.3/pyproject.toml

@@ -0,0 +1,162 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "quickpub"
+version = "4.1.3"
+authors = [
+    { name = "danielnachumdev", email = "danielnachumdev@gmail.com" },
+]
+dependencies = [
+    "danielutils>=1.1.23",
+    "requests",
+    "fire",
+    "twine",
+]
+keywords = []
+license = { "file" = "./LICENSE" }
+description = "A local CI/CD simulation tool that runs quality checks, tests, and validations locally before publishing Python packages, ensuring higher build pass rates and faster feedback loops"
+readme = {file = "./README.md", content-type = "text/markdown"}
+requires-python = ">=3.8.0"
+classifiers = [
+	"Development Status :: 5 - Production/Stable",
+	"Environment :: Console",
+	"Intended Audience :: Developers",
+	"License :: OSI Approved :: MIT License",
+	"Operating System :: OS Independent",
+	"Programming Language :: Python",
+	"Programming Language :: Python :: 3",
+	"Programming Language :: Python :: 3 :: Only",
+	"Programming Language :: Python :: 3.8",
+	"Programming Language :: Python :: 3.9",
+	"Programming Language :: Python :: 3.10",
+	"Programming Language :: Python :: 3.11",
+	"Programming Language :: Python :: 3.12",
+	"Programming Language :: Python :: 3.13",
+	"Topic :: Software Development :: Build Tools",
+	"Topic :: Software Development :: Libraries :: Python Modules",
+	"Topic :: Software Development :: Quality Assurance",
+	"Typing :: Typed",
+]
+[project.scripts]
+    quickpub = "quickpub.__main__:main"
+
+[tool.setuptools]
+packages = ["quickpub"]
+
+[tool.setuptools.package-data]
+"quickpub" = ["py.typed"]
+
+[project.urls]
+"Homepage" = "https://github.com/danielnachumdev/quickpub"
+"Bug Tracker" = "https://github.com/danielnachumdev/quickpub/issues"
+
+[dependency-groups]
+dev = [
+    "githooklib>=1.0.0",
+    "tqdm",
+    "pylint",
+    "mypy",
+    "types-tqdm",
+    "types-requests",
+    "beautifulsoup4",
+    "setuptools",
+    "black",
+]
+test = [
+    "pytest",
+    "pytest-xdist",
+    "pytest-asyncio",
+    "pytest-cov",
+]
+
+[tool.uv]
+default-groups = ["dev", "test"]
+
+[tool.pytest.ini_options]
+asyncio_default_fixture_loop_scope = "function"
+testpaths = ["tests"]
+python_files = ["test_*.py"]
+python_classes = ["Test*"]
+python_functions = ["test_*"]
+addopts = [
+    "-q",
+    "--strict-markers",
+    "--tb=short",
+    "--cov",
+    "--cov-report=html",
+    "--cov-report=term-missing",
+    "--color=yes",
+    "--durations=10",
+    "--maxfail=10",
+]
+markers = [
+    "unit: Unit tests",
+    "integration: Integration tests",
+    "slow: Slow running tests",
+]
+
+[tool.coverage.run]
+source = ["quickpub"]
+branch = false
+parallel = false
+
+[tool.coverage.report]
+precision = 2
+show_missing = true
+skip_covered = false
+fail_under = 50
+sort = "Cover"
+
+[tool.coverage.html]
+directory = "htmlcov"
+
+[tool.mypy]
+disallow_untyped_calls = true
+check_untyped_defs = true
+no_implicit_optional = true
+strict_optional = true
+namespace_packages = true
+explicit_package_bases = true
+files = ["quickpub/*.py", "tests", "publish.py"]
+
+[[tool.mypy.overrides]]
+module = "*"
+ignore_missing_imports = true
+
+[tool.pylint.main]
+ignore-paths = ["^tests/.*", "^tmp/.*"]
+
+[tool.pylint.basic]
+good-names = ["foo", "bar"]
+good-names-rgxs = ["^[a-zA-Z]"]
+
+[tool.pylint.naming]
+class-rgx = "^(_)?[A-Z][a-zA-Z0-9]*$"
+module-rgx = "^[a-zA-Z][a-zA-Z0-9_]*$"
+
+[tool.pylint.messages_control]
+disable = [
+    "W0211",
+    "C0114",
+    "E1120",
+    "E0611",
+    "W0702",
+    "W0612",
+    "R0913",
+    "C0415",
+    "R0912",
+    "R0903",
+    "R0914",
+    "R0911",
+    "R1716",
+    "W0401",
+    "R0801",
+    "C0116",
+    "W0212",
+    "C0115",
+]
+
+[tool.pylint.format]
+max-line-length = 120

{quickpub-4.1.1 → quickpub-4.1.3}/quickpub/__init__.py

@@ -1,9 +1,10 @@
 from .structures import *
 from .strategies import *
+from .classifiers import *
 from .enforcers import ExitEarlyError
 from .qa import SupportsProgress
 from .logging_ import set_log_level
 from .package_manager_detection import detect_package_manager, resolve_publish_environment
 from .__main__ import publish, main
 
-__version__ = "4.1.1"
+__version__ = "4.1.3"