Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

v1.0 Rewrite #12

Draft
wants to merge 19 commits into
base: master
Choose a base branch
from
Draft

v1.0 Rewrite #12

wants to merge 19 commits into from

Conversation

jwodder
Copy link
Owner

@jwodder jwodder commented Nov 4, 2023

Closes #2.
Closes #5.

Major changes so far (See the changelog for more):

  • The info, readme, releases, files, owner, and owned commands now take exactly one positional argument, and the output formats of many of these commands have been simplified for this case.
  • Package yanking is now honored.
  • There is now a library API.
  • Package arguments to info, files, and readme can now be requirements specifiers (e.g., click>=5.0, <8.1) that are used to filter the available versions

To do:

  • Add a note to the README about search being disabled
  • Add public documentation for the new library API
    • Set up a Read the Docs site?
  • Update all docs (including command docstrings and command example output)
  • Add QyPIError subclasses for missing projects vs. no matching versions
  • Add an option (--no-pre?) for erroring rather than falling back to prereleases when a project only has prereleases
  • More tests
    • Test --yanked/--no-yanked options
    • Test QyPI & related classes directly without involving the click interface
  • Account for the fact that the version-specific endpoints no longer include a releases key in their responses (ref)
  • Try to make the use of "release" vs. "version" consistent
    • Give releases a versions synonym? (Use click-aliases?)
    • Rename releases to versions?
  • Give --latest-version a shorter alternative spelling

@jwodder jwodder added breaking change Introduction of an incompatible API change in progress Currently under development labels Nov 4, 2023
@jwodder jwodder added this to the v1.0 milestone Nov 4, 2023
Copy link

codecov bot commented Nov 4, 2023

Codecov Report

Merging #12 (089b7c6) into master (28b78a4) will decrease coverage by 3.06%.
Report is 1 commits behind head on master.
The diff coverage is 87.50%.

@@            Coverage Diff             @@
##           master      #12      +/-   ##
==========================================
- Coverage   91.24%   88.18%   -3.06%     
==========================================
  Files           4        4              
  Lines         274      381     +107     
  Branches      107      126      +19     
==========================================
+ Hits          250      336      +86     
- Misses         13       31      +18     
- Partials       11       14       +3     
Files Coverage Δ
src/qypi/__init__.py 100.00% <100.00%> (ø)
src/qypi/util.py 77.77% <71.42%> (-20.69%) ⬇️
src/qypi/__main__.py 86.29% <84.78%> (-5.45%) ⬇️
src/qypi/api.py 89.30% <89.03%> (+4.96%) ⬆️

@jwodder jwodder added the enhancement New feature or request therefor label Nov 4, 2023
@jwodder jwodder self-assigned this Dec 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking change Introduction of an incompatible API change enhancement New feature or request therefor in progress Currently under development
Projects
None yet
Development

Successfully merging this pull request may close these issues.

qypi as a Library Tests
1 participant