quickpub 4.1.4__py3-none-any.whl

quickpub-4.1.4.dist-info/METADATA

@@ -0,0 +1,246 @@
+Metadata-Version: 2.4
+Name: quickpub
+Version: 4.1.4
+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.4.dist-info/RECORD

@@ -0,0 +1,58 @@
+quickpub/__init__.py,sha256=sT03kdYmkADtYQQdkMR4gLBj0BrkREWdsH8C2GAqPyg,336
+quickpub/__main__.py,sha256=wnKzPTbnaq6-X2gqbm4fv2B4V2VrUX5cqUbEgV8yg6w,8575
+quickpub/classifiers.py,sha256=Jh-P5LU9oxLo0eOlKlXGX__VihDXRRKBdi-6Va5tbKM,3526
+quickpub/dist_files.py,sha256=WYk0-_GqJ1twwAPcMkWFe10-Y8emtuXH86duF7KOclw,910
+quickpub/enforcers.py,sha256=VJivLdf9OpbYOidr7U1XPOK32ljzgzjAcmWnJFCfk18,467
+quickpub/files.py,sha256=NZyf6ENHkmReVFNLOU1dhpNNokYDN95tdDPzMqGiIG4,7898
+quickpub/logging_.py,sha256=ytz_tAMuXD8Bdc93koIPJs0hopsy7PCEnOuc16WHl_s,1768
+quickpub/package_manager_detection.py,sha256=PipqipevVFifcje-iHNQ2eBJHRZWOQQEIKXoI4zq7qE,1531
+quickpub/proxy.py,sha256=7E4NrChaYi_ChEzPKCbwuYYkfpiTUpXtznpKf6ymQig,984
+quickpub/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+quickpub/qa.py,sha256=d549uMoRFe_djIGEMt5Za4zwvhl-lzr7iH4ZGiopa7U,13472
+quickpub/validators.py,sha256=C0tkcC7cVutihDiczJss9Sfr4raSzGR2EwacpMn7Srg,2881
+quickpub/worker_pool.py,sha256=pJDgkC3o2TRYkylshrJzxJS9TdUlXZQORuhPPFb_otg,331
+quickpub/strategies/__init__.py,sha256=oQOY4dGcp7qToyKoruMniHcubnBmuPsAji1BzgbRJ5c,258
+quickpub/strategies/build_schema.py,sha256=c0dslk6n-89V7soQoRYgbsHtrGCL9uewLKEmWHVCjrk,567
+quickpub/strategies/constraint_enforcer.py,sha256=eDk9XOYs20esiY9Y-5QOxFXwWbxeFZaAqEPTuoU_Rs4,476
+quickpub/strategies/package_manager.py,sha256=Mvk4fQMpQNKQiXRiod7owK4anHM8m8_58cRWQmWSYkU,1611
+quickpub/strategies/python_provider.py,sha256=D0laGunrhxPl9B4SRlN_-BYwigMsonLZwlHLbuAV5aI,1963
+quickpub/strategies/quality_assurance_runner.py,sha256=q0WrLitCNrRNuCew-CwzvJunsg88ytTk3oiXgou1LfA,7075
+quickpub/strategies/quickpub_strategy.py,sha256=ICrND6AKUGFoBjvEKTYVlCt4P7G1H1Uvp8RPadEx0EQ,251
+quickpub/strategies/upload_target.py,sha256=dEckyByfRQePm2FknNAKzQxwIWMmgDJzhZkMO3BAZdU,441
+quickpub/strategies/implementations/__init__.py,sha256=MNk66038L-p2xEoHcmIOLiMrxCyadXy6KLQ_15b1G5A,200
+quickpub/strategies/implementations/build_schemas/__init__.py,sha256=3Mep9qqhNJZ0C9jUM4ap-fzG3HUC4LY5gDiiUrcTH_8,70
+quickpub/strategies/implementations/build_schemas/setuptools_build_schema.py,sha256=2QiXxjpuGQNo5uLMh_kH7VWHqdaHe5FXtw0FqXUruiE,1435
+quickpub/strategies/implementations/build_schemas/uv_build_schema.py,sha256=A2e-IubggwYe11pmrvbgabGvyV9kQvhUnc322dTqqFc,1534
+quickpub/strategies/implementations/constraint_enforcers/__init__.py,sha256=nbkEiMVA7mSvYmggeIni5pfDtx73ycqBqVeJiZy6c6w,176
+quickpub/strategies/implementations/constraint_enforcers/license_enforcer.py,sha256=SKekRtVkRc0aG0dgEy1IWHnQnb4XVXvcsV8xWORvVuY,782
+quickpub/strategies/implementations/constraint_enforcers/local_version_enforcer.py,sha256=PXdn55RSPqGoe7brOp0WFWX4eQ4SrcwIcfMgFUtx0ok,2522
+quickpub/strategies/implementations/constraint_enforcers/pypi_remote_version_enforcer.py,sha256=iH0tN-pKkBQSV0x749WMSmkkjozemNjYdVlN_heoOhg,3185
+quickpub/strategies/implementations/constraint_enforcers/pypirc_enforcer.py,sha256=vocOqzyPtj2s8e1req78dsLsJFVjIFp2ix78PpT04Jk,1544
+quickpub/strategies/implementations/constraint_enforcers/readme_enforcer.py,sha256=s17Sd24pXbwqdvkPWegxcwOMNky0GtBEnI_D3IR95zI,777
+quickpub/strategies/implementations/package_managers/__init__.py,sha256=fsvRbYUMtEIdaimfrPA1DqBc1ePokbqDJEYbzDa41Yg,69
+quickpub/strategies/implementations/package_managers/installed_package_parser.py,sha256=c7W0MQEIvvaiG9DHTn1jVr0Di48y6b8iHKw5FTJ0xvY,937
+quickpub/strategies/implementations/package_managers/pip_package_manager.py,sha256=8ydUiP5PfoNubgxuBEX95WMMHLJv50h3O6kB7xqFnQ0,882
+quickpub/strategies/implementations/package_managers/uv_package_manager.py,sha256=bb_DUAT1Td2rQ1I8NEys-XEjZ0kjyPkCISFYPwGA_2s,1449
+quickpub/strategies/implementations/python_providers/__init__.py,sha256=pDi1ltg9I2ICwVTNWInwrT-fDnGhpdu3eFiDjN4JgQ0,140
+quickpub/strategies/implementations/python_providers/conda_python_provider.py,sha256=v286dGvOQP81Kar1qh9OFqIsH5AU-TuZcQSdg6olA74,1973
+quickpub/strategies/implementations/python_providers/default_python_provider.py,sha256=8nvcNaUF5Xb6c90bKgAiDxgPNR0fet8wzv_hySwJIkI,1351
+quickpub/strategies/implementations/python_providers/union_provider.py,sha256=ZoUqsXb5JZj5wj6T_cJXP1A5NSmuf6XY5HSiqYMG72g,1809
+quickpub/strategies/implementations/python_providers/uv_python_provider.py,sha256=kY0klgegjYWR7rIo-AO3rA4KzQgEBOuY3HUpNwaB7Y0,1291
+quickpub/strategies/implementations/quality_assurance_runners/__init__.py,sha256=B1SmATiw_JDEKb_LD6HO3Z-bmeXVr9qpi0NiuCj3sNM,128
+quickpub/strategies/implementations/quality_assurance_runners/mypy_qa_runner.py,sha256=RwsYjF0cqt3cg1WCsEjBXA8aGN88-odTj_iAHf2H4Zo,3359
+quickpub/strategies/implementations/quality_assurance_runners/pylint_qa_runner.py,sha256=eNNiVh4stTgATafywvMUCZTiUnOhvDQtAEMK2s0GwBA,3577
+quickpub/strategies/implementations/quality_assurance_runners/pytest_qa_runner.py,sha256=z32xlhqpmE8kCTuMdJh40LtA1Aj9OPtg9kM8tLZFamo,7194
+quickpub/strategies/implementations/quality_assurance_runners/unittest_qa_runner.py,sha256=2VfXGi8vUSxuoOmxt0GeVwty_XdMWKhPusvEECekbuE,5366
+quickpub/strategies/implementations/upload_targets/__init__.py,sha256=pqnPeb5fT3iSFVgXk4zGMUModOnO37c2iIe7udQdCMM,72
+quickpub/strategies/implementations/upload_targets/github_upload_target.py,sha256=jC_6dY__biZfwXyJEsWs5usZs4_X50uOZ5_wCznNc0M,1888
+quickpub/strategies/implementations/upload_targets/pypirc_upload_target.py,sha256=h0v64pFLU4XJq3XpePeaP9QOFf7Rf1ll_27wwtNOeGw,3258
+quickpub/structures/__init__.py,sha256=sd59nFwTzDNHbIhWsCBxmJPOiNrfblMzML4sNHoXUHs,70
+quickpub/structures/bound.py,sha256=nVxbFqdWi93fTkafXNE6W37_9l4F83BMEcQ2oyhNyvo,1513
+quickpub/structures/dependency.py,sha256=1q32l9C6ZmNVDzVXTJoceAIiLP4RQRNIuKV73iKKdlc,2673
+quickpub/structures/version.py,sha256=QSStdpE8cPzCRJ35dzcAe2MW57JjCuDuTH20xxoCnFY,1253
+quickpub-4.1.4.dist-info/licenses/LICENSE,sha256=eX4kxC_qAAe3zRjafiU3KW9xVKSHQREmwzxClRhVipM,1071
+quickpub-4.1.4.dist-info/METADATA,sha256=vkmYGB4Ul7cr_Afdz4II1q_pBRBeZ42jyAzuBsVi20k,8438
+quickpub-4.1.4.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+quickpub-4.1.4.dist-info/entry_points.txt,sha256=ezFH8Kvprv8CX1tQTAzVGGcaAalU3qPVgZGF-tjoZEk,52
+quickpub-4.1.4.dist-info/top_level.txt,sha256=CPmdha8VMY6vS5ZyBXW8Ij4VTzeYVCYt31Z6WESSSfA,9
+quickpub-4.1.4.dist-info/RECORD,,

quickpub-4.1.4.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.2.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

quickpub-4.1.4.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+quickpub = quickpub.__main__:main

quickpub-4.1.4.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+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.

quickpub-4.1.4.dist-info/top_level.txt

@@ -0,0 +1 @@
+quickpub