fromager 0.0.1__tar.gz

fromager-0.0.1/.containerignore

@@ -0,0 +1,15 @@
+**/__pycache__/*
+*.egg-info/*
+*.log
+.cache/*
+.cargo/*
+.git/*
+.tox/*
+.venv/*
+artifacts/*
+build/*
+build-logs/*
+sdists-repo/*
+venv*
+wheels-repo/*
+work-dir*/*

fromager-0.0.1/.github/workflows/check.yaml

@@ -0,0 +1,64 @@
+name: Check
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  linter:
+    name: linter
+    runs-on: ubuntu-latest
+    if: ${{ !startsWith(github.ref, 'refs/tags') }}
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"  # minimum supported lang version
+
+      - name: Install dependencies
+        run: python -m pip install tox
+
+      - name: Run
+        run: tox -e linter
+
+  pkglint:
+    name: pkglint
+    runs-on: ubuntu-latest
+    if: ${{ !startsWith(github.ref, 'refs/tags') }}
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"  # minimum supported lang version
+
+      - name: Install dependencies
+        run: python -m pip install tox
+
+      - name: Run
+        run: tox -e pkglint
+
+  markdownlint:
+    # https://github.com/marketplace/actions/markdown-lint
+    name: markdownlint
+    runs-on: ubuntu-latest
+    if: ${{ !startsWith(github.ref, 'refs/tags') }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: articulate/actions-markdownlint@v1.1.0
+        with:
+          config: .markdownlint-config.yaml
+        #   files: 'docs/**/*.md'
+        #   ignore: node_modules
+        #   version: 0.28.1

fromager-0.0.1/.github/workflows/python-publish.yaml

@@ -0,0 +1,38 @@
+# This workflows will upload a Python Package using Twine when a release is created
+# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
+
+name: Upload Python Package
+
+on:
+  - push
+
+jobs:
+  build-n-publish:
+    name: Build and publish Python distributions to PyPI
+    if: ${{ github.repository_owner == 'python-wheel-build' }}
+
+    runs-on: ubuntu-latest
+    environment: release
+
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+
+    steps:
+    - uses: actions/checkout@v2
+      # with:
+      #   fetch-depth: 0
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.11'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install .[build]
+    - name: Build sdist and wheel
+      run: |
+        python -m build
+    - name: Publish distribution to PyPI
+      if: startsWith(github.ref, 'refs/tags')
+      uses: pypa/gh-action-pypi-publish@release/v1

fromager-0.0.1/.github/workflows/test.yaml

@@ -0,0 +1,62 @@
+# Based on https://fedoramagazine.org/github-actions-use-podman-to-run-fedora-linux/
+
+name: CI
+on:
+  pull_request:
+
+jobs:
+  unit:
+    name: unit
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version:
+          - "3.11"
+          - "3.12"
+
+    steps:
+      - name: Get source
+        uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: python -m pip install tox
+
+      - name: Run tests
+        run: tox -e py
+
+  e2e:
+    name: e2e
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version:
+          - "3.11"
+          - "3.12"
+        test-script:
+          - bootstrap
+          - report_missing_dependency
+          - build_with_build_order
+
+    steps:
+      - name: Get source
+        uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: python -m pip install tox
+
+      - name: Run tests
+        run: ./e2e/test_${{ matrix.test-script }}.sh

fromager-0.0.1/.gitignore

@@ -0,0 +1,20 @@
+__pycache__/
+.*.log
+/sdists-repo/
+/wheels-repo/
+/work-dir*/
+/test-venv/
+/venv*/
+/build/
+**/*.egg-info/
+/src/fromager/version.py
+/.coverage
+/artifacts
+/build-logs/
+/.pypirc
+/.tox/
+/node_modules/
+/package-lock.json
+/package.json
+/e2e-output/
+/dist/

fromager-0.0.1/.markdownlint-config.yaml

@@ -0,0 +1,14 @@
+# really, this is a rule?
+commands-show-output: false
+
+# Don't check line length
+line-length: false
+
+# We only publish HTML, so allow all HTML inline.
+no-inline-html: false
+
+# Don't require specifying code language
+fenced-code-language: false
+
+# We sometimes put URLs in docs without making them links
+no-bare-urls: false

fromager-0.0.1/.mergify.yml

@@ -0,0 +1,46 @@
+pull_request_rules:
+  - name: Add CI label
+    conditions:
+      - or:
+          - 'title~=^tox:'
+          - 'title~=^ci:'
+          - files~=tox.ini
+          - files~=.github/
+          - files~=.markdownlint-config.yaml
+    actions:
+      label:
+        add:
+          - ci
+  - name: Add Mergify label
+    conditions:
+      - or:
+          - 'title~=^mergify:'
+          - files~=.mergify.yml$
+    actions:
+      label:
+        add:
+          - mergify
+  - name: Automatic merge on approval
+    conditions:
+      - and:
+          - check-success=linter
+          - check-success=pkglint
+          - check-success=markdownlint
+          - check-success=unit (3.11)
+          - check-success=unit (3.12)
+          - check-success=e2e (3.11, bootstrap)
+          - check-success=e2e (3.12, bootstrap)
+          - check-success=e2e (3.11, report_missing_dependency)
+          - check-success=e2e (3.12, report_missing_dependency)
+          - check-success=e2e (3.11, build_with_build_order)
+          - check-success=e2e (3.12, build_with_build_order)
+          - '-draft'
+          # - or:
+          #     - check-success=history-update
+          #     - label=ci
+          - or:
+              - approved-reviews-by=dhellmann
+              - author=dhellmann
+    actions:
+      merge:
+        method: merge

fromager-0.0.1/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2022 MicroShift Authors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

fromager-0.0.1/PKG-INFO

@@ -0,0 +1,108 @@
+Metadata-Version: 2.1
+Name: fromager
+Version: 0.0.1
+Summary: Wheel maker
+Author-email: Mark McLoughlin <markmc@redhat.com>, Doug Hellmann <dhellmann@redhat.com>
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD 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.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Utilities
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: html5lib
+Requires-Dist: packaging
+Requires-Dist: pkginfo
+Requires-Dist: PyYAML
+Requires-Dist: pyproject_hooks!=1.1.0,>=1.0.0
+Requires-Dist: python-gitlab
+Requires-Dist: python-pypi-mirror
+Requires-Dist: requests
+Requires-Dist: resolvelib
+Requires-Dist: stevedore
+Requires-Dist: tomli
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: coverage!=4.4,>=4.0; extra == "test"
+Provides-Extra: build
+Requires-Dist: build; extra == "build"
+Requires-Dist: twine; extra == "build"
+
+# fromager
+
+Fromager is a tool for completely re-building a dependency tree of
+Python wheels from source.
+
+1. The [binary
+   package](https://packaging.python.org/en/latest/glossary/#term-Built-Distribution)
+   they are installing was built from source in a known build
+   environment compatible with their own environment
+1. All of the package’s dependencies were also built from source -- any
+   binary package installed will have been built from source
+1. All of the build tools used to build these binary packages will
+   also have been built from source.
+
+## Modes
+
+Fromager has different modes for bootstrapping and production builds.
+The bootstrap mode recursively processes all dependencies starting
+from the requirements specifications given to determine what needs to
+be built and what order to build it. The production build commands
+separate these steps and avoid recursive processing so each step can
+be performed in isolation.
+
+## Bootstrapping
+
+The `bootstrap` command
+
+* Creates an empty package repository for
+  [wheels](https://packaging.python.org/en/latest/specifications/binary-distribution-format/)
+* Downloads the [source
+  distributions](https://packaging.python.org/en/latest/glossary/#term-Source-Distribution-or-sdist)
+  for the input packages and places them under
+  `sdists-repo/downloads/`.
+* Recurses through the dependencies
+  * Firstly, any build system dependency specified in the
+    pyproject.toml build-system.requires section as per
+    [PEP517](https://peps.python.org/pep-0517)
+  * Secondly, any build backend dependency returned from the
+    get_requires_for_build_wheel() build backend hook (PEP517 again)
+  * Lastly, any install-time dependencies of the project as per the
+    wheel’s [core
+    metadata](https://packaging.python.org/en/latest/specifications/core-metadata/)
+    `Requires-Dist` list.
+* As each wheel is built, it is placed in a [PEP503 "simple" package
+  repository](https://peps.python.org/pep-0503/) under
+  `wheels-repo/simple` generated by
+  [pypi-mirror](https://pypi.org/project/python-pypi-mirror/).
+* The order the dependencies need to be built bottom-up is written to
+  `build-order.json`.
+
+Wheels are built by running `pip wheel` configured so it will only
+download dependencies from the local wheel repository. This ensures
+that all dependencies are being built in the correct order.
+
+## Additional docs
+
+* [Package build customization instructions](docs/customization.md)
+* [Developer instructions](docs/develop.md)
+
+## What's with the name?
+
+Python's name comes from Monty Python, the group of comedians. One of
+their skits is about a cheese shop that has no cheese in stock. The
+original Python Package Index (pypi.org) was called The Cheeseshop, in
+part because it hosted metadata about packages but no actual
+packages. The wheel file format was selected because cheese is
+packaged in wheels. A
+"[fromager](https://en.wiktionary.org/wiki/fromager)" is the French
+word for someone who makes or sells cheese.

fromager-0.0.1/README.md

@@ -0,0 +1,69 @@
+# fromager
+
+Fromager is a tool for completely re-building a dependency tree of
+Python wheels from source.
+
+1. The [binary
+   package](https://packaging.python.org/en/latest/glossary/#term-Built-Distribution)
+   they are installing was built from source in a known build
+   environment compatible with their own environment
+1. All of the package’s dependencies were also built from source -- any
+   binary package installed will have been built from source
+1. All of the build tools used to build these binary packages will
+   also have been built from source.
+
+## Modes
+
+Fromager has different modes for bootstrapping and production builds.
+The bootstrap mode recursively processes all dependencies starting
+from the requirements specifications given to determine what needs to
+be built and what order to build it. The production build commands
+separate these steps and avoid recursive processing so each step can
+be performed in isolation.
+
+## Bootstrapping
+
+The `bootstrap` command
+
+* Creates an empty package repository for
+  [wheels](https://packaging.python.org/en/latest/specifications/binary-distribution-format/)
+* Downloads the [source
+  distributions](https://packaging.python.org/en/latest/glossary/#term-Source-Distribution-or-sdist)
+  for the input packages and places them under
+  `sdists-repo/downloads/`.
+* Recurses through the dependencies
+  * Firstly, any build system dependency specified in the
+    pyproject.toml build-system.requires section as per
+    [PEP517](https://peps.python.org/pep-0517)
+  * Secondly, any build backend dependency returned from the
+    get_requires_for_build_wheel() build backend hook (PEP517 again)
+  * Lastly, any install-time dependencies of the project as per the
+    wheel’s [core
+    metadata](https://packaging.python.org/en/latest/specifications/core-metadata/)
+    `Requires-Dist` list.
+* As each wheel is built, it is placed in a [PEP503 "simple" package
+  repository](https://peps.python.org/pep-0503/) under
+  `wheels-repo/simple` generated by
+  [pypi-mirror](https://pypi.org/project/python-pypi-mirror/).
+* The order the dependencies need to be built bottom-up is written to
+  `build-order.json`.
+
+Wheels are built by running `pip wheel` configured so it will only
+download dependencies from the local wheel repository. This ensures
+that all dependencies are being built in the correct order.
+
+## Additional docs
+
+* [Package build customization instructions](docs/customization.md)
+* [Developer instructions](docs/develop.md)
+
+## What's with the name?
+
+Python's name comes from Monty Python, the group of comedians. One of
+their skits is about a cheese shop that has no cheese in stock. The
+original Python Package Index (pypi.org) was called The Cheeseshop, in
+part because it hosted metadata about packages but no actual
+packages. The wheel file format was selected because cheese is
+packaged in wheels. A
+"[fromager](https://en.wiktionary.org/wiki/fromager)" is the French
+word for someone who makes or sells cheese.