├── .codespellrc
├── .github
└── workflows
│ └── code-checks.yaml
├── .gitignore
├── .pre-commit-config.yaml
├── .pylintrc
├── .python-version
├── ChangeLog.md
├── LICENSE
├── Makefile
├── README.md
├── img
├── pispy-description.png
├── pispy-wheel.png
└── pispy.png
├── pyproject.toml
├── requirements-dev.lock
├── requirements.lock
└── src
└── pispy
├── __init__.py
├── __main__.py
├── app.py
├── data
├── __init__.py
└── package.py
├── py.typed
└── widgets
├── __init__.py
└── package_information.py
/.codespellrc:
--------------------------------------------------------------------------------
1 | [codespell]
2 | ignore-words-list=wee
3 |
--------------------------------------------------------------------------------
/.github/workflows/code-checks.yaml:
--------------------------------------------------------------------------------
1 | name: Code quality checks
2 |
3 | on:
4 | push:
5 | branches:
6 | - main
7 | pull_request:
8 |
9 | jobs:
10 |
11 | quality-checks:
12 |
13 | name: Quality checks
14 | runs-on: ubuntu-latest
15 | strategy:
16 | matrix:
17 | python-version: ["3.10", "3.11", "3.12", "3.13"]
18 |
19 | steps:
20 |
21 | - name: Checkout Code
22 | uses: actions/checkout@v4
23 |
24 | - name: Set up Python
25 | uses: actions/setup-python@v4
26 | with:
27 | python-version: ${{ matrix.python-version }}
28 |
29 | - name: Install Rye
30 | uses: eifinger/setup-rye@v4
31 | with:
32 | version: "latest"
33 |
34 | - name: Install Dependencies
35 | run: |
36 | echo ${{ matrix.python-version }} > .python-version
37 | make setup
38 |
39 | - name: Check for typos
40 | run: make spellcheck
41 |
42 | - name: Check the code style
43 | run: make codestyle
44 |
45 | - name: Lint the code
46 | run: make lint
47 |
48 | - name: Type check the code
49 | run: make stricttypecheck
50 |
51 | ### code-checks.yaml ends here
52 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | .venv/
2 | .coverage
3 | .coverage_report/
4 | .DS_Store
5 | *.egg-info/
6 | build/
7 | dist/
8 | __pycache__
9 |
--------------------------------------------------------------------------------
/.pre-commit-config.yaml:
--------------------------------------------------------------------------------
1 | repos:
2 | - repo: https://github.com/astral-sh/ruff-pre-commit
3 | # Ruff version.
4 | rev: v0.6.4
5 | hooks:
6 | # Run the linter.
7 | - id: ruff
8 | args: [ --fix, --select, I ]
9 | # Run the formatter.
10 | - id: ruff-format
11 | - repo: https://github.com/codespell-project/codespell
12 | rev: v2.4.1
13 | hooks:
14 | - id: codespell
15 |
--------------------------------------------------------------------------------
/.pylintrc:
--------------------------------------------------------------------------------
1 | [FORMAT]
2 | max-line-length=120
3 |
4 | [MESSAGES CONTROL]
5 | disable=fixme
6 |
--------------------------------------------------------------------------------
/.python-version:
--------------------------------------------------------------------------------
1 | 3.12.4
2 |
--------------------------------------------------------------------------------
/ChangeLog.md:
--------------------------------------------------------------------------------
1 | # PISpy ChangeLog
2 |
3 | ## v1.0.0
4 |
5 | **Released: 2025-04-12**
6 |
7 | - Small cosmetic tweaks. ([#35](https://github.com/davep/pispy/pull/35))
8 |
9 | ## 0.9.0
10 |
11 | **Released: 2024-11-27**
12 |
13 | - Updated for newer versions of Textual.
14 | - Internal tweaks.
15 |
16 | ## 0.8.0
17 |
18 | **Released: 2024-06-16**
19 |
20 | - Updated Textual and fixed breakage.
21 | - Added link-following support to the package description pane, when the
22 | description is seen as Markdown and the link can be reasonably followed.
23 |
24 | ## 0.7.0
25 |
26 | **Released: 2024-04-22**
27 |
28 | - The keywords display now allows for keywords that are space or comma
29 | separated. ([#21](https://github.com/davep/pispy/issues/21))
30 | - The download count is now no longer shown (it is always `-1` anyway).
31 | ([#23](https://github.com/davep/pispy/pull/23))
32 | - Requirements are now de-duplicated and sorted.
33 | ([#24](https://github.com/davep/pispy/pull/24))
34 | - Made the UI a bit more minimal.
35 | ([#26](https://github.com/davep/pispy/pull/26))
36 | - Switched to using
37 | [`Packaging`](https://packaging.pypa.io/en/stable/index.html) to parse
38 | dependency package details.
39 |
40 | ## 0.6.0
41 |
42 | **Released: 2024-04-17**
43 |
44 | - Add support for passing a package name on the command line.
45 | - Show the package details inline in the terminal if the package name was
46 | passed on the command line.
47 | - Big reworking of the whole UI.
48 |
49 | ## 0.5.0
50 |
51 | **Released: 2024-04-12**
52 |
53 | - Reworked the way the metadata is shown
54 | ([#2](https://github.com/davep/pispy/issues/2)).
55 | - Clicking on URLs in the display now opens the default web browser
56 | ([#7](https://github.com/davep/pispy/issues/7)).
57 |
58 | ## 0.4.0
59 |
60 | **Released: 2023-02-17**
61 |
62 | - Updated to Textual v0.11.1, and started using the new Markdown widget to
63 | display markdown data.
64 |
65 | ## 0.3.0
66 |
67 | **Released: 2023-01-07**
68 |
69 | - Updated to the latest version of Textual, and make changes to take Textual
70 | changes into account. Also pinned the version of Textual (for now).
71 |
72 | ## 0.2.0
73 |
74 | **Released: 2022-12-10**
75 |
76 | - This release rounds out the data that is displayed when brought back from
77 | the JSON interface.
78 |
79 | ## 0.1.0
80 |
81 | **Released: 2022-11-30**
82 |
83 | - Initial release.
84 |
85 | [//]: # (ChangeLog.md ends here)
86 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------
/Makefile:
--------------------------------------------------------------------------------
1 | app := pispy
2 | src := src/
3 | run := rye run
4 | python := $(run) python
5 | lint := rye lint -- --select I
6 | fmt := rye fmt
7 | mypy := $(run) mypy
8 | spell := $(run) codespell
9 |
10 | ##############################################################################
11 | # Local "interactive testing" of the code.
12 | .PHONY: run
13 | run: # Run the code in a testing context
14 | $(python) -m $(app)
15 |
16 | ##############################################################################
17 | # Setup/update packages the system requires.
18 | .PHONY: setup
19 | setup: # Set up the repository for development
20 | rye sync
21 | $(run) pre-commit install
22 |
23 | .PHONY: update
24 | update: # Update all dependencies
25 | rye sync --update-all
26 |
27 | .PHONY: resetup
28 | resetup: # Recreate the virtual environment from scratch
29 | rm -rf .venv
30 | make setup
31 |
32 | ##############################################################################
33 | # Checking/testing/linting/etc.
34 | .PHONY: lint
35 | lint: # Check the code for linting issues
36 | $(lint) $(src)
37 |
38 | .PHONY: codestyle
39 | codestyle: # Is the code formatted correctly?
40 | $(fmt) --check $(src)
41 |
42 | .PHONY: typecheck
43 | typecheck: # Perform static type checks with mypy
44 | $(mypy) --scripts-are-modules $(src)
45 |
46 | .PHONY: stricttypecheck
47 | stricttypecheck: # Perform a strict static type checks with mypy
48 | $(mypy) --scripts-are-modules --strict $(src)
49 |
50 | .PHONY: spellcheck
51 | spellcheck: # Spell check the code
52 | $(spell) *.md $(src) $(docs) $(tests)
53 |
54 | .PHONY: checkall
55 | checkall: spellcheck codestyle lint stricttypecheck # Check all the things
56 |
57 | ##############################################################################
58 | # Package/publish.
59 | .PHONY: package
60 | package: # Package the library
61 | rye build
62 |
63 | .PHONY: spackage
64 | spackage: # Create a source package for the library
65 | rye build --sdist
66 |
67 | .PHONY: testdist
68 | testdist: package # Perform a test distribution
69 | rye publish --yes --skip-existing --repository testpypi --repository-url https://test.pypi.org/legacy/
70 |
71 | .PHONY: dist
72 | dist: package # Upload to pypi
73 | rye publish --yes --skip-existing
74 |
75 | ##############################################################################
76 | # Utility.
77 | .PHONY: repl
78 | repl: # Start a Python REPL in the venv.
79 | $(python)
80 |
81 | .PHONY: updatedeps
82 | updatedeps: # Update all dependencies
83 | rye sync --update-all
84 |
85 | .PHONY: delint
86 | delint: # Fix linting issues.
87 | $(lint) --fix $(src)
88 |
89 | .PHONY: pep8ify
90 | pep8ify: # Reformat the code to be as PEP8 as possible.
91 | $(fmt) $(src)
92 |
93 | .PHONY: tidy
94 | tidy: delint pep8ify # Tidy up the code, fixing lint and format issues.
95 |
96 | .PHONY: clean
97 | clean: # Clean the build directories
98 | rm -rf dist
99 |
100 | .PHONY: help
101 | help: # Display this help
102 | @grep -Eh "^[a-z]+:.+# " $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.+# "}; {printf "%-20s %s\n", $$1, $$2}'
103 |
104 | ##############################################################################
105 | # Housekeeping tasks.
106 | .PHONY: housekeeping
107 | housekeeping: # Perform some git housekeeping
108 | git fsck
109 | git gc --aggressive
110 | git remote update --prune
111 |
112 | ### Makefile ends here
113 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # PISpy
2 |
3 | ## Introduction
4 |
5 | PISpy aims to be a simple but useful [PyPI](https://pypi.org/) lookup client
6 | for the terminal.
7 |
8 | ## Installation
9 |
10 | ### pipx
11 |
12 | The package can be installed using [`pipx`](https://pypa.github.io/pipx/):
13 |
14 | ```sh
15 | $ pipx install pispy-client
16 | ```
17 |
18 | ### Homebrew
19 |
20 | The package can be installed using Homebrew. Use the following commands to
21 | install:
22 |
23 | ```sh
24 | $ brew tap davep/homebrew
25 | $ brew install pispy
26 | ```
27 |
28 | ## Running
29 |
30 | Once installed, just run `pispy` from your shell.
31 |
32 | 
33 |
34 | 
35 |
36 | 
37 |
38 | [//]: # (README.md ends here)
39 |
--------------------------------------------------------------------------------
/img/pispy-description.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/davep/pispy/e49e0649ae50702dfed98cbb1d745cb37a1d8dea/img/pispy-description.png
--------------------------------------------------------------------------------
/img/pispy-wheel.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/davep/pispy/e49e0649ae50702dfed98cbb1d745cb37a1d8dea/img/pispy-wheel.png
--------------------------------------------------------------------------------
/img/pispy.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/davep/pispy/e49e0649ae50702dfed98cbb1d745cb37a1d8dea/img/pispy.png
--------------------------------------------------------------------------------
/pyproject.toml:
--------------------------------------------------------------------------------
1 | [project]
2 | name = "pispy-client"
3 | version = "1.0.0"
4 | description = "A terminal-based Python package index inspector"
5 | authors = [
6 | { name = "Dave Pearson", email = "davep@davep.org" }
7 | ]
8 | dependencies = [
9 | "httpx",
10 | "packaging",
11 | "textual>=3.1.0",
12 | ]
13 | readme = "README.md"
14 | requires-python = ">=3.10"
15 | license = { text = "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)" }
16 | classifiers = [
17 | "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)",
18 | "Environment :: Console",
19 | "Development Status :: 5 - Production/Stable",
20 | "Intended Audience :: End Users/Desktop",
21 | "Natural Language :: English",
22 | "Operating System :: OS Independent",
23 | "Programming Language :: Python :: 3.10",
24 | "Programming Language :: Python :: 3.11",
25 | "Programming Language :: Python :: 3.12",
26 | "Programming Language :: Python :: 3.13",
27 | "Topic :: Internet",
28 | "Topic :: Terminals",
29 | "Typing :: Typed",
30 | ]
31 |
32 | [project.urls]
33 | Homepage = "https://github.com/davep/pispy"
34 | Repository = "https://github.com/davep/pispy"
35 | Documentation = "https://github.com/davep/pispy/blob/main/README.md"
36 | Source = "https://github.com/davep/pispy"
37 | Issues = "https://github.com/davep/pispy/issues"
38 | Discussions = "https://github.com/davep/pispy/discussions"
39 |
40 | [project.scripts]
41 | pispy = "pispy.__main__:run"
42 |
43 | [build-system]
44 | # https://github.com/astral-sh/rye/issues/1446
45 | requires = ["hatchling==1.26.3", "hatch-vcs"]
46 | # requires = ["hatchling"]
47 | build-backend = "hatchling.build"
48 |
49 | [tool.rye]
50 | managed = true
51 | dev-dependencies = [
52 | "pre-commit>=4.0.1",
53 | "mypy>=1.13.0",
54 | "codespell>=2.4.1",
55 | ]
56 |
57 | [tool.hatch.metadata]
58 | allow-direct-references = true
59 |
60 | [tool.hatch.build.targets.wheel]
61 | packages = ["src/pispy"]
62 |
--------------------------------------------------------------------------------
/requirements-dev.lock:
--------------------------------------------------------------------------------
1 | # generated by rye
2 | # use `rye lock` or `rye sync` to update this lockfile
3 | #
4 | # last locked with the following flags:
5 | # pre: false
6 | # features: []
7 | # all-features: false
8 | # with-sources: false
9 | # generate-hashes: false
10 | # universal: false
11 |
12 | -e file:.
13 | anyio==4.9.0
14 | # via httpx
15 | certifi==2025.1.31
16 | # via httpcore
17 | # via httpx
18 | cfgv==3.4.0
19 | # via pre-commit
20 | codespell==2.4.1
21 | distlib==0.3.9
22 | # via virtualenv
23 | filelock==3.18.0
24 | # via virtualenv
25 | h11==0.14.0
26 | # via httpcore
27 | httpcore==1.0.8
28 | # via httpx
29 | httpx==0.28.1
30 | # via pispy-client
31 | identify==2.6.9
32 | # via pre-commit
33 | idna==3.10
34 | # via anyio
35 | # via httpx
36 | linkify-it-py==2.0.3
37 | # via markdown-it-py
38 | markdown-it-py==3.0.0
39 | # via mdit-py-plugins
40 | # via rich
41 | # via textual
42 | mdit-py-plugins==0.4.2
43 | # via markdown-it-py
44 | mdurl==0.1.2
45 | # via markdown-it-py
46 | mypy==1.15.0
47 | mypy-extensions==1.0.0
48 | # via mypy
49 | nodeenv==1.9.1
50 | # via pre-commit
51 | packaging==24.2
52 | # via pispy-client
53 | platformdirs==4.3.7
54 | # via textual
55 | # via virtualenv
56 | pre-commit==4.2.0
57 | pygments==2.19.1
58 | # via rich
59 | pyyaml==6.0.2
60 | # via pre-commit
61 | rich==14.0.0
62 | # via textual
63 | sniffio==1.3.1
64 | # via anyio
65 | textual==3.1.0
66 | # via pispy-client
67 | typing-extensions==4.13.2
68 | # via anyio
69 | # via mypy
70 | # via textual
71 | uc-micro-py==1.0.3
72 | # via linkify-it-py
73 | virtualenv==20.30.0
74 | # via pre-commit
75 |
--------------------------------------------------------------------------------
/requirements.lock:
--------------------------------------------------------------------------------
1 | # generated by rye
2 | # use `rye lock` or `rye sync` to update this lockfile
3 | #
4 | # last locked with the following flags:
5 | # pre: false
6 | # features: []
7 | # all-features: false
8 | # with-sources: false
9 | # generate-hashes: false
10 | # universal: false
11 |
12 | -e file:.
13 | anyio==4.9.0
14 | # via httpx
15 | certifi==2025.1.31
16 | # via httpcore
17 | # via httpx
18 | h11==0.14.0
19 | # via httpcore
20 | httpcore==1.0.8
21 | # via httpx
22 | httpx==0.28.1
23 | # via pispy-client
24 | idna==3.10
25 | # via anyio
26 | # via httpx
27 | linkify-it-py==2.0.3
28 | # via markdown-it-py
29 | markdown-it-py==3.0.0
30 | # via mdit-py-plugins
31 | # via rich
32 | # via textual
33 | mdit-py-plugins==0.4.2
34 | # via markdown-it-py
35 | mdurl==0.1.2
36 | # via markdown-it-py
37 | packaging==24.2
38 | # via pispy-client
39 | platformdirs==4.3.7
40 | # via textual
41 | pygments==2.19.1
42 | # via rich
43 | rich==14.0.0
44 | # via textual
45 | sniffio==1.3.1
46 | # via anyio
47 | textual==3.1.0
48 | # via pispy-client
49 | typing-extensions==4.13.2
50 | # via anyio
51 | # via textual
52 | uc-micro-py==1.0.3
53 | # via linkify-it-py
54 |
--------------------------------------------------------------------------------
/src/pispy/__init__.py:
--------------------------------------------------------------------------------
1 | """PISpy - A Terminal-Based Python Package Index Inspector"""
2 |
3 | ##############################################################################
4 | # Python imports.
5 | from importlib.metadata import version
6 |
7 | ######################################################################
8 | # Main app information.
9 | __author__ = "Dave Pearson"
10 | __copyright__ = "Copyright 2022-2024, Dave Pearson"
11 | __credits__ = ["Dave Pearson"]
12 | __maintainer__ = "Dave Pearson"
13 | __email__ = "davep@davep.org"
14 | __version__ = version("pispy-client")
15 | __licence__ = "GPLv3+"
16 |
17 | ### __init__.py ends here
18 |
--------------------------------------------------------------------------------
/src/pispy/__main__.py:
--------------------------------------------------------------------------------
1 | """Main entry point for running the application."""
2 |
3 | ##############################################################################
4 | # Python imports.
5 | from argparse import ArgumentParser, Namespace
6 |
7 | ##############################################################################
8 | # Local imports.
9 | from . import __version__
10 | from .app import PISpy
11 |
12 |
13 | ##############################################################################
14 | def get_args() -> Namespace:
15 | """Get the command line arguments.
16 |
17 | Returns:
18 | The parsed command line arguments.
19 | """
20 | parser = ArgumentParser(
21 | prog="pispy",
22 | description="Look up package information on PyPI.",
23 | epilog=f"v{__version__}",
24 | )
25 |
26 | # Add the package argument.
27 | parser.add_argument(
28 | "package",
29 | nargs="?",
30 | help="A package to look up",
31 | )
32 |
33 | # Add --version
34 | parser.add_argument(
35 | "-v",
36 | "--version",
37 | help="Show version information.",
38 | action="version",
39 | version=f"%(prog)s {__version__}",
40 | )
41 |
42 | # Return the arguments.
43 | return parser.parse_args()
44 |
45 |
46 | ##############################################################################
47 | def run() -> None:
48 | """Run the application."""
49 | arguments = get_args()
50 | PISpy(arguments.package).run(inline=arguments.package is not None)
51 |
52 |
53 | ##############################################################################
54 | # Run the app if we're being called on as the main entry point.
55 | if __name__ == "__main__":
56 | run()
57 |
58 | ### __main__.py ends here
59 |
--------------------------------------------------------------------------------
/src/pispy/app.py:
--------------------------------------------------------------------------------
1 | """Provides the main application class."""
2 |
3 | ##############################################################################
4 | # Textual imports.
5 | from textual import on
6 | from textual.app import App, ComposeResult
7 | from textual.widgets import Input
8 |
9 | ##############################################################################
10 | # Local imports.
11 | from .widgets import PackageInformation
12 |
13 |
14 | ##############################################################################
15 | class PISpy(App[None]):
16 | """The main application class."""
17 |
18 | CSS = """
19 | Input {
20 | border: none;
21 | border-bottom: solid $foreground 20%;
22 | background: $panel;
23 | height: 2;
24 | &:focus {
25 | border: none;
26 | border-bottom: solid $foreground 30%;
27 | }
28 | }
29 |
30 | Screen:inline {
31 | height: 50vh;
32 |
33 | Input {
34 | display: none;
35 | }
36 | }
37 |
38 | * {
39 | /* Let's make scrollbars a wee bit thinner. */
40 | scrollbar-size-vertical: 1;
41 | }
42 | """
43 |
44 | BINDINGS = [("escape", "quit", "Quit")]
45 | """The main application bindings."""
46 |
47 | ENABLE_COMMAND_PALETTE = False
48 | """Disable the command palette."""
49 |
50 | def __init__(self, initial_package: str | None) -> None:
51 | """Initialise the application.
52 |
53 | Args:
54 | initial_package: The initial package to look up.
55 | """
56 | super().__init__()
57 | self._package = initial_package
58 |
59 | def compose(self) -> ComposeResult:
60 | """Compose the stats screen.
61 |
62 | Returns:
63 | The stats screen's layout.
64 | """
65 | yield Input(placeholder="Name of the package to look up in PyPI")
66 | yield PackageInformation()
67 |
68 | async def on_mount(self) -> None:
69 | """Pre-fill the display if a package is passed on the command line."""
70 | if self._package is not None:
71 | await self.run_action(f"lookup('{self._package}')")
72 |
73 | @on(Input.Submitted)
74 | def lookup_package(self) -> None:
75 | """React to the user hitting enter in the input field."""
76 | if self.query_one(PackageInformation).show(self.query_one(Input).value):
77 | self.query_one(PackageInformation).focus()
78 |
79 | def action_lookup(self, package: str) -> None:
80 | """React to a hyperlink of a project being clicked on.
81 |
82 | Args:
83 | package: The name of the package to look up.
84 | """
85 | self.query_one(Input).value = package
86 | self.query_one(Input).cursor_position = len(package)
87 | self.lookup_package()
88 |
89 |
90 | ### app.py ends here
91 |
--------------------------------------------------------------------------------
/src/pispy/data/__init__.py:
--------------------------------------------------------------------------------
1 | """Code for getting data from PyPI."""
2 |
3 | ##############################################################################
4 | # Local imports.
5 | from .package import Package, PackageURL
6 |
7 | ##############################################################################
8 | # Exports.
9 | __all__ = ["Package", "PackageURL"]
10 |
11 | ### __init__.py ends here
12 |
--------------------------------------------------------------------------------
/src/pispy/data/package.py:
--------------------------------------------------------------------------------
1 | """Provides a class for getting data for a PyPI package."""
2 |
3 | ##############################################################################
4 | # Python imports.
5 | from functools import partial
6 | from re import split
7 | from typing import Any, NamedTuple
8 |
9 | ##############################################################################
10 | # httpx imports.
11 | import httpx
12 |
13 |
14 | ##############################################################################
15 | def _get(
16 | payload: dict[str, dict[str, Any]], via: str, value: str, default: Any = ""
17 | ) -> Any:
18 | """Get some data, default if it isn't there or is `None`.
19 |
20 | Args:
21 | payload: The payload from the API.
22 | via: The child collection to get the value via.
23 | value: The value to get.
24 | default: The default to use.
25 |
26 | Returns:
27 | The value found, or the default.
28 |
29 | Note:
30 | The default is used if `value` can't be found, or if it is `None`.
31 | """
32 | return default if (result := payload.get(via, {}).get(value)) is None else result
33 |
34 |
35 | ##############################################################################
36 | class PackageURL(NamedTuple):
37 | """A package's release URL data."""
38 |
39 | comment_text: str
40 | """The comment text for the URL."""
41 |
42 | digests: dict[str, str]
43 | """The digests for the URL."""
44 |
45 | downloads: int
46 | """The number of downloads for the URL."""
47 |
48 | filename: str
49 | """The filename for the URL."""
50 |
51 | has_sig: bool
52 | """Does the URL have a signature?"""
53 |
54 | md5_digest: str
55 | """The MD5 digest for the URL."""
56 |
57 | packagetype: str
58 | """The type of package."""
59 |
60 | python_version: str
61 | """The version of package for this URL."""
62 |
63 | size: int
64 | """The size of the download at this URL."""
65 |
66 | upload_time_iso_8601: str
67 | """The upload time of the URL in ISo 8601 format."""
68 |
69 | url: str
70 | """The URL itself."""
71 |
72 | yanked: bool
73 | """Has this URL been yanked?"""
74 |
75 | yanked_reason: str
76 | """The reason for the yank, if the URL has been yanked."""
77 |
78 | @classmethod
79 | def from_json(cls, data: dict[str, Any]) -> "PackageURL":
80 | """Get package URL information from the given data.
81 |
82 | Args:
83 | data: The URL data.
84 |
85 | Returns:
86 | An instance of a `PackageURL` class.
87 | """
88 | url = partial(_get, {"url": data}, "url")
89 | return cls(
90 | comment_text=url("comment_text"),
91 | digests=url("digests", {}),
92 | downloads=url("downloads", 0),
93 | filename=url("filename"),
94 | has_sig=url("has_sig", False),
95 | md5_digest=url("md5_digest"),
96 | packagetype=url("packagetype"),
97 | python_version=url("python_version"),
98 | size=url("size", 0),
99 | upload_time_iso_8601=url("upload_time_iso_8601"),
100 | url=url("url"),
101 | yanked=url("yanked", False),
102 | yanked_reason=url("yanked_reason"),
103 | )
104 |
105 |
106 | ##############################################################################
107 | class Package(NamedTuple):
108 | """A Package in PyPI."""
109 |
110 | author: str
111 | """The author of the package."""
112 |
113 | author_email: str
114 | """The email address of the author."""
115 |
116 | bugtrack_url: str
117 | """The URL for the package's bug tracker."""
118 |
119 | classifiers: list[str]
120 | """The list of classifiers for the package."""
121 |
122 | description: str
123 | """The description for the package."""
124 |
125 | description_content_type: str
126 | """The content type of the description."""
127 |
128 | docs_url: str
129 | """The URL for the packages documentation."""
130 |
131 | download_url: str
132 | """The URL to download the package."""
133 |
134 | homepage: str
135 | """The homepage for the package."""
136 |
137 | keywords: list[str]
138 | """The keywords for the package."""
139 |
140 | license: str
141 | """The licence for the package."""
142 |
143 | maintainer: str
144 | """The name of the maintainer of the package."""
145 |
146 | maintainer_email: str
147 | """The email address of the maintainer of the package."""
148 |
149 | name: str
150 | """The name of the package."""
151 |
152 | package_url: str
153 | """The URL for the package."""
154 |
155 | platform: str
156 | """The platform for the package."""
157 |
158 | project_url: str
159 | """The URL of the project for the package."""
160 |
161 | project_urls: dict[str, str]
162 | """The URLs for the project associated with the package."""
163 |
164 | release_url: str
165 | """The URL of the latest release of the package."""
166 |
167 | requires_dist: list[str]
168 | """The requirements for the distribution of the package."""
169 |
170 | requires_python: str
171 | """The version of Python required for the package."""
172 |
173 | summary: str
174 | """The summary of the package."""
175 |
176 | version: str
177 | """The version of the package."""
178 |
179 | yanked: bool
180 | """Has the package been yanked?"""
181 |
182 | yanked_reason: str
183 | """The reason for the yank, if the package has been yanked."""
184 |
185 | urls: list[PackageURL]
186 | """The URLs for this package."""
187 |
188 | @classmethod
189 | async def from_pypi(cls, package: str) -> tuple[bool, "Package"]:
190 | """Get information on the given package from PyPI.
191 |
192 | Args:
193 | package: The name of the package to get data for.
194 |
195 | Returns:
196 | A flag to say if the package was found and package data.
197 | """
198 |
199 | async with httpx.AsyncClient() as client:
200 | # Get the package's data from the API.
201 | resp = await client.get(
202 | f"https://pypi.org/pypi/{package}/json", follow_redirects=True
203 | )
204 |
205 | # Extract the main payload data.
206 | data = resp.json()
207 |
208 | # Create the function to get the main package information.
209 | info = partial(_get, data, "info")
210 |
211 | # TODO: Do this in a less-monolothic way.
212 | return resp.status_code == httpx.codes.OK, cls(
213 | author=info("author"),
214 | author_email=info("author_email"),
215 | bugtrack_url=info("bugtrack_url"),
216 | classifiers=info("classifiers", []),
217 | description=info("description"),
218 | description_content_type=info("description_content_type"),
219 | docs_url=info("docs_url"),
220 | download_url=info("download_url"),
221 | homepage=info("home_page"),
222 | keywords=split("[ ,]+", info("keywords")),
223 | license=info("license"),
224 | maintainer=info("maintainer"),
225 | maintainer_email=info("maintainer_email"),
226 | name=info("name"),
227 | package_url=info("package_url"),
228 | platform=info("platform"),
229 | project_url=info("project_url"),
230 | project_urls=info("project_urls", {}),
231 | release_url=info("release_url"),
232 | requires_dist=info("requires_dist", []),
233 | requires_python=info("requires_python"),
234 | summary=info("summary"),
235 | version=info("version"),
236 | yanked=info("yanked", False),
237 | yanked_reason=info("yanked_reason"),
238 | urls=[PackageURL.from_json(url) for url in data.get("urls", [])],
239 | )
240 |
241 |
242 | ### package.py ends here
243 |
--------------------------------------------------------------------------------
/src/pispy/py.typed:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/davep/pispy/e49e0649ae50702dfed98cbb1d745cb37a1d8dea/src/pispy/py.typed
--------------------------------------------------------------------------------
/src/pispy/widgets/__init__.py:
--------------------------------------------------------------------------------
1 | """Widgets used in the application."""
2 |
3 | ##############################################################################
4 | # Local imports.
5 | from .package_information import PackageInformation
6 |
7 | ##############################################################################
8 | # Export widgets.
9 | __all__ = ["PackageInformation"]
10 |
11 | ### __init__.py ends here
12 |
--------------------------------------------------------------------------------
/src/pispy/widgets/package_information.py:
--------------------------------------------------------------------------------
1 | """A window for showing information on a PyPI package."""
2 |
3 | ##############################################################################
4 | # Python imports.
5 | from functools import singledispatch
6 | from typing import Any, Callable, Iterator
7 | from urllib.parse import urlparse
8 | from webbrowser import open as visit_url
9 |
10 | ##############################################################################
11 | # Packing imports.
12 | from packaging.requirements import Requirement
13 |
14 | ##############################################################################
15 | # Textual imports.
16 | from textual import on, work
17 | from textual.app import ComposeResult
18 | from textual.containers import VerticalScroll
19 | from textual.css.query import NoMatches
20 | from textual.message import Message
21 | from textual.widget import Widget
22 | from textual.widgets import Label, Markdown, TabbedContent, TabPane, Tabs
23 |
24 | ##############################################################################
25 | # Backward compatible typing.
26 | from typing_extensions import Self
27 |
28 | ##############################################################################
29 | # Local imports.
30 | from ..data import Package, PackageURL
31 |
32 |
33 | ##############################################################################
34 | class Title(Label):
35 | """A title for an item of package information."""
36 |
37 | DEFAULT_CSS = """
38 | Title {
39 | background: $panel-lighten-3;
40 | margin-right: 1;
41 | text-style: bold;
42 | width: 1fr;
43 | }
44 | """
45 | """The defaults styles."""
46 |
47 | def __init__(self, text: str) -> None:
48 | """Initialise the title.
49 |
50 | Args:
51 | text: The title.
52 | """
53 | super().__init__(f"{text}:")
54 |
55 |
56 | ##############################################################################
57 | class Value(Label):
58 | """A value for an item of package information."""
59 |
60 | DEFAULT_CSS = """
61 | Value {
62 | margin-right: 1;
63 | padding-bottom: 1;
64 | width: 1fr;
65 | }
66 | """
67 |
68 |
69 | ##############################################################################
70 | class URL(Label):
71 | """A URL for an item of package information."""
72 |
73 | DEFAULT_CSS = """
74 | URL {
75 | margin-right: 1;
76 | padding-bottom: 1;
77 | width: 1fr;
78 | }
79 | """
80 |
81 | @staticmethod
82 | def looks_urlish(url: str) -> bool:
83 | """Test if a given string looks like an actual URL.
84 |
85 | Args:
86 | url: The URL to test.
87 |
88 | Returns:
89 | `True` if it really looks like a URL, `False` if not.
90 | """
91 | return bool(urlparse(url).scheme)
92 |
93 | def __init__(self, url: str) -> None:
94 | """Initialise the URL.
95 |
96 | Args:
97 | url: The URL.
98 | """
99 | super().__init__(
100 | f"[@click=visit('{url}')]{url}[/]" if self.looks_urlish(url) else url
101 | )
102 |
103 | def action_visit(self, url: str) -> None:
104 | """Visit the given URL.
105 |
106 | Args:
107 | url: The URL to visit.
108 | """
109 | visit_url(url)
110 |
111 |
112 | ##############################################################################
113 | @singledispatch
114 | def maybe_show(
115 | title: str, value: Any, widget: Callable[[Any], Widget]
116 | ) -> Iterator[Widget]:
117 | """Maybe show a value with a given title.
118 |
119 | Args:
120 | title: The title for the value to show.
121 | value: The value to show.
122 | widget: The type of widget to show the value.
123 |
124 | Yields:
125 | The widgets required to show the value.
126 | """
127 | yield Title(title)
128 | yield widget(value)
129 |
130 |
131 | ##############################################################################
132 | @maybe_show.register
133 | def _(title: str, value: None, widget: Callable[[Any], Widget]) -> Iterator[Widget]:
134 | """Show noting when the value is `None`."""
135 | del title, value, widget
136 | yield from ()
137 |
138 |
139 | ##############################################################################
140 | @maybe_show.register
141 | def _(title: str, value: str, widget: Callable[[Any], Widget]) -> Iterator[Widget]:
142 | """Maybe show a string value."""
143 | if value:
144 | yield Title(title)
145 | yield widget(value)
146 |
147 |
148 | ##############################################################################
149 | def widgets_for(*values: tuple[str, Any, Callable[[Any], Widget]]) -> Iterator[Widget]:
150 | """Generate the widgets needed to show the given values.
151 |
152 | Args:
153 | values: The collection of values to show.
154 |
155 | Yields:
156 | The widgets required to show the values.
157 | """
158 | for title, value, display in values:
159 | yield from maybe_show(title, value, display)
160 |
161 |
162 | ##############################################################################
163 | class TabContent(VerticalScroll):
164 | """A wrapper for the content of a package information tab."""
165 |
166 | class GoLeft(Message):
167 | """Message to request we move left in the tabs."""
168 |
169 | class GoRight(Message):
170 | """Message to request we move right in the tabs."""
171 |
172 | def action_scroll_left(self) -> None:
173 | """Handle a request to go left."""
174 | self.post_message(self.GoLeft())
175 |
176 | def action_scroll_right(self) -> None:
177 | """Handle a request to go right."""
178 | self.post_message(self.GoRight())
179 |
180 |
181 | ##############################################################################
182 | class PackageURLDetails(TabPane):
183 | """Tab pane for showing details of a package URL."""
184 |
185 | def __init__(self, package_url: PackageURL) -> None:
186 | """Initialise the object.
187 |
188 | Args:
189 | package_url: The package URL to show.
190 | """
191 | super().__init__(package_url.filename)
192 | self._url = package_url
193 |
194 | def compose(self) -> ComposeResult:
195 | """Compose the package URL display.
196 |
197 | Returns:
198 | The package URL data layout.
199 | """
200 | with TabContent():
201 | yield from widgets_for(
202 | ("URL", self._url.url, URL),
203 | ("Package Type", self._url.packagetype, Value),
204 | ("Python Version", self._url.python_version, Value),
205 | ("Size", f"{self._url.size:,}", Value),
206 | ("MD5 Digest", self._url.md5_digest, Value),
207 | ("Uploaded", self._url.upload_time_iso_8601, Value),
208 | ("Has Signature", "Yes" if self._url.has_sig else "No", Value),
209 | ("Comments", self._url.comment_text, Value),
210 | *((name, value, Value) for name, value in self._url.digests.items()),
211 | ("Yanked", "Yes" if self._url.yanked else "No", Value),
212 | ("Yanked Reason", self._url.yanked_reason, Value),
213 | )
214 |
215 |
216 | ##############################################################################
217 | class PackageDescription(TabPane):
218 | """A tab pane that shows the package description."""
219 |
220 | def __init__(self, package: Package):
221 | """Initialise the package description pane."""
222 | super().__init__("Description")
223 | self._package = package
224 |
225 | def compose(self) -> ComposeResult:
226 | with TabContent():
227 | yield (
228 | Markdown
229 | if self._package.description_content_type == "text/markdown"
230 | else Value
231 | )(self._package.description, id="description")
232 |
233 | @on(Markdown.LinkClicked)
234 | def maybe_handle_url(self, event: Markdown.LinkClicked) -> None:
235 | """Maybe handle a link coming from the `Markdown` widget.
236 |
237 | Args:
238 | event: The link click event.
239 | """
240 | if URL.looks_urlish(event.href):
241 | visit_url(event.href)
242 |
243 |
244 | ##############################################################################
245 | class PackageUnknown(TabPane):
246 | """Tab pane used to show that the package was unknown."""
247 |
248 | DEFAULT_CSS = """
249 | PackageUnknown {
250 | height: 1fr;
251 | align: center middle;
252 | Label {
253 | background: $error;
254 | border: round $boost;
255 | text-style: bold;
256 | content-align: center middle;
257 | width: 75%;
258 | height: 50%;
259 | }
260 | }
261 | """
262 |
263 | def __init__(self, package_name: str):
264 | """Initialise the package unknown pane."""
265 | super().__init__("[red]Unknown[/]")
266 | self._package_name = package_name
267 |
268 | def compose(self) -> ComposeResult:
269 | yield Label(f"Package '{self._package_name}' is not available on PyPI")
270 |
271 |
272 | ##############################################################################
273 | class PackageDetails(TabPane):
274 | """A tab pane that shows the details of the package."""
275 |
276 | def __init__(self, package: Package):
277 | """Initialise the package details pane."""
278 | super().__init__("Details")
279 | self._package = package
280 |
281 | def compose(self) -> ComposeResult:
282 | """Compose the package details display.
283 |
284 | Returns:
285 | The package URL data layout.
286 | """
287 | with TabContent():
288 | yield from widgets_for(
289 | ("Name", self._package.name, Value),
290 | ("Version", self._package.version, Value),
291 | ("Summary", self._package.summary, Value),
292 | ("URL", self._package.package_url, URL),
293 | ("Author", self._package.author, Value),
294 | ("Email", self._package.author_email, Value),
295 | ("Bug Track URL", self._package.bugtrack_url, URL),
296 | ("Classifiers", "\n".join(self._package.classifiers), Value),
297 | ("Documentation URL", self._package.docs_url, URL),
298 | ("Download URL", self._package.download_url, URL),
299 | ("Homepage", self._package.homepage, URL),
300 | ("Keywords", ", ".join(self._package.keywords), Value),
301 | ("License", self._package.license, Value),
302 | ("Maintainer", self._package.maintainer, Value),
303 | ("Email", self._package.maintainer_email, Value),
304 | ("Platform", self._package.platform, Value),
305 | ("Project URL", self._package.project_url, URL),
306 | *(
307 | (title, value, URL)
308 | for title, value in self._package.project_urls.items()
309 | ),
310 | ("Release URL", self._package.release_url, URL),
311 | (
312 | "Requires",
313 | ", ".join(
314 | sorted(
315 | set(
316 | f"[@click=app.lookup('{pkg.name}')]{pkg.name}[/]"
317 | for pkg in (
318 | Requirement(requirement)
319 | for requirement in self._package.requires_dist
320 | )
321 | )
322 | )
323 | ),
324 | Value,
325 | ),
326 | ("Yanked", "Yes" if self._package.yanked else "No", Value),
327 | ("Yanked Reason", self._package.yanked_reason, Value),
328 | )
329 |
330 |
331 | ##############################################################################
332 | class PackageInformation(TabbedContent):
333 | """A widget for showing information about a PyPI package."""
334 |
335 | DEFAULT_CSS = """
336 | PackageInformation {
337 | Tab {
338 | padding: 0;
339 | margin: 0 1;
340 | }
341 | background: $panel;
342 | height: 1fr;
343 | &> * {
344 | visibility: hidden;
345 | }
346 | &.content > * {
347 | visibility: visible;
348 | }
349 | Markdown {
350 | background: transparent;
351 | }
352 | }
353 | """
354 |
355 | BINDINGS = [
356 | ("up, down, home, end, pageup, pagedown", "focus_details"),
357 | ]
358 |
359 | @work(exclusive=True)
360 | async def show(self, package_name: str) -> bool:
361 | """Show the package information for the given package.
362 |
363 | Args:
364 | package_name: The name of the package to lookup and show
365 |
366 | Returns:
367 | `True` if the package was found, `False` if not.
368 | """
369 |
370 | # Don't bother trying to do anything if there isn't actually a name.
371 | if not package_name.strip():
372 | return False
373 |
374 | # Mark that there's content now.
375 | self.set_class(True, "content")
376 |
377 | # Show we're loading.
378 | self.loading = True
379 |
380 | # Clear any existing content.
381 | self.clear_panes()
382 |
383 | # Download the data for the package.
384 | found, package = await Package.from_pypi(package_name)
385 |
386 | if found:
387 | self.add_pane(PackageDetails(package))
388 | if package.description.strip():
389 | self.add_pane(PackageDescription(package))
390 | for url in package.urls:
391 | self.add_pane(PackageURLDetails(url))
392 | else:
393 | self.add_pane(PackageUnknown(package_name))
394 |
395 | # We're all done now.
396 | self.loading = False
397 |
398 | return found
399 |
400 | @on(TabContent.GoLeft)
401 | async def tab_leftward(self) -> None:
402 | """Handle a request to move leftward."""
403 | await self.query_one(Tabs).focus().run_action("previous_tab")
404 |
405 | @on(TabContent.GoRight)
406 | async def tab_righttward(self) -> None:
407 | """Handle a request to move rightward."""
408 | await self.query_one(Tabs).focus().run_action("next_tab")
409 |
410 | def action_focus_details(self) -> None:
411 | """Handle a request to ensure the content is focused."""
412 | if self.active_pane is not None and self.screen.focused == self.query_one(Tabs):
413 | try:
414 | self.active_pane.query_one(TabContent).focus()
415 | except NoMatches:
416 | pass
417 |
418 | def focus(self, scroll_visible: bool = True) -> Self:
419 | self.query_one(Tabs).focus(scroll_visible)
420 | return self
421 |
422 |
423 | ### package_information.py ends here
424 |
--------------------------------------------------------------------------------