Skip to content

[FEATURE] Unit tests and documentation #24

@arifer612

Description

@arifer612

IDEA

Pippel should be able to test against released Pip versions to make sure it functions as it advertises. The results should be reflected in the README file in the form of a table for users to see. Any known failures (such as known yanked Pip releases) should be reflected appropriately.

Implementation

The main issue every time Pip is released is the compatibility of pippel.py with Pip. For that, all we need to check is whether through pippel.py, are we able to list, install, and uninstall arbitrary Python packages in isolated environments. A simple PyTest should do the trick. We can go about it in one of 2 ways:

  1. A monolithic test module where a single test script checks against all relevant Python and Pip versions at once and update the documentation. This can be done on any machine.
  2. GitHub Actions matrix where we test against all Python and Pip versions separately. This is done purely through CI/CD.

The documentation needs to be updated properly. If the first choice is picked above, it can be built rather easily on the same machine or by CI/CD. If, however, the second choice above is picked, the documentation has to be built together with the test results through CI/CD.

Metadata

Metadata

Assignees

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions