pip-brief 1.0.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- pip_brief-1.0.0/LICENSE +21 -0
- pip_brief-1.0.0/PKG-INFO +152 -0
- pip_brief-1.0.0/README.md +101 -0
- pip_brief-1.0.0/pip_brief/__init__.py +0 -0
- pip_brief-1.0.0/pip_brief/cli.py +40 -0
- pip_brief-1.0.0/pip_brief/core.py +200 -0
- pip_brief-1.0.0/pip_brief.egg-info/PKG-INFO +152 -0
- pip_brief-1.0.0/pip_brief.egg-info/SOURCES.txt +11 -0
- pip_brief-1.0.0/pip_brief.egg-info/dependency_links.txt +1 -0
- pip_brief-1.0.0/pip_brief.egg-info/entry_points.txt +2 -0
- pip_brief-1.0.0/pip_brief.egg-info/top_level.txt +1 -0
- pip_brief-1.0.0/pyproject.toml +42 -0
- pip_brief-1.0.0/setup.cfg +4 -0
pip_brief-1.0.0/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 Nachiket Mehendale
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
pip_brief-1.0.0/PKG-INFO
ADDED
|
@@ -0,0 +1,152 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: pip-brief
|
|
3
|
+
Version: 1.0.0
|
|
4
|
+
Summary: A simple wrapper for pip install with clean, organized output
|
|
5
|
+
Author-email: Nachiket Mehendale <your-email@example.com>
|
|
6
|
+
License: MIT License
|
|
7
|
+
|
|
8
|
+
Copyright (c) 2025 Nachiket Mehendale
|
|
9
|
+
|
|
10
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
11
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
12
|
+
in the Software without restriction, including without limitation the rights
|
|
13
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
14
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
15
|
+
furnished to do so, subject to the following conditions:
|
|
16
|
+
|
|
17
|
+
The above copyright notice and this permission notice shall be included in all
|
|
18
|
+
copies or substantial portions of the Software.
|
|
19
|
+
|
|
20
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
21
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
22
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
23
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
24
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
25
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
26
|
+
SOFTWARE.
|
|
27
|
+
Project-URL: Homepage, https://github.com/Nachiket-Mehendale/pip-brief
|
|
28
|
+
Project-URL: Repository, https://github.com/Nachiket-Mehendale/pip-brief
|
|
29
|
+
Project-URL: Issues, https://github.com/Nachiket-Mehendale/pip-brief/issues
|
|
30
|
+
Keywords: pip,wrapper,cli,package-manager,install,summary
|
|
31
|
+
Classifier: Development Status :: 5 - Production/Stable
|
|
32
|
+
Classifier: Intended Audience :: Developers
|
|
33
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
34
|
+
Classifier: Operating System :: OS Independent
|
|
35
|
+
Classifier: Programming Language :: Python :: 3
|
|
36
|
+
Classifier: Programming Language :: Python :: 3.6
|
|
37
|
+
Classifier: Programming Language :: Python :: 3.7
|
|
38
|
+
Classifier: Programming Language :: Python :: 3.8
|
|
39
|
+
Classifier: Programming Language :: Python :: 3.9
|
|
40
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
41
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
42
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
43
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
44
|
+
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
45
|
+
Classifier: Topic :: System :: Installation/Setup
|
|
46
|
+
Classifier: Topic :: Utilities
|
|
47
|
+
Requires-Python: >=3.6
|
|
48
|
+
Description-Content-Type: text/markdown
|
|
49
|
+
License-File: LICENSE
|
|
50
|
+
Dynamic: license-file
|
|
51
|
+
|
|
52
|
+
# pip-brief
|
|
53
|
+
|
|
54
|
+
A clean, human-readable wrapper for `pip install` that provides organized summaries of installation results.
|
|
55
|
+
|
|
56
|
+
## Features
|
|
57
|
+
|
|
58
|
+
- **Clean Output Format**: Organized summary with numbered sections
|
|
59
|
+
- **Comprehensive Tracking**: Shows installed packages, already satisfied requirements, warnings, errors, and dependencies
|
|
60
|
+
- **Duplicate Removal**: Eliminates repetitive messages for cleaner output
|
|
61
|
+
- **Verbose Mode**: Option to see full pip output when needed
|
|
62
|
+
- **Simple Interface**: Easy-to-use command structure
|
|
63
|
+
|
|
64
|
+
## Installation
|
|
65
|
+
|
|
66
|
+
```bash
|
|
67
|
+
pip install pip-brief
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
## Usage
|
|
71
|
+
|
|
72
|
+
### Install one or more packages with brief summary:
|
|
73
|
+
```bash
|
|
74
|
+
pip-brief install <package-name>
|
|
75
|
+
pip-brief install <package1> <package2> <package3>
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
### Install with verbose output (shows full pip output):
|
|
79
|
+
```bash
|
|
80
|
+
pip-brief install <package-name> --verbose
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
## Example Output
|
|
84
|
+
|
|
85
|
+
### Single Package:
|
|
86
|
+
```
|
|
87
|
+
**Summary of requests installation:**
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
1) Installed:
|
|
91
|
+
requests (2.31.0), urllib3 (2.0.4), certifi (2023.7.22)
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
2) Already Satisfied:
|
|
95
|
+
charset-normalizer, idna
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
3) Dependencies:
|
|
99
|
+
requests, urllib3, certifi, charset-normalizer, idna
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
### Multiple Packages:
|
|
103
|
+
```
|
|
104
|
+
**Summary of loguru installation:**
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
1) Installed:
|
|
108
|
+
loguru (0.7.3)
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
2) Dependencies:
|
|
112
|
+
loguru
|
|
113
|
+
|
|
114
|
+
==================================================
|
|
115
|
+
|
|
116
|
+
**Summary of emoji installation:**
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
1) Installed:
|
|
120
|
+
emoji (2.8.0)
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
2) Dependencies:
|
|
124
|
+
emoji
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
## Output Format
|
|
128
|
+
|
|
129
|
+
The summary is organized into up to 5 sections (only applicable sections are shown):
|
|
130
|
+
|
|
131
|
+
1. **Installed**: Packages that were newly installed
|
|
132
|
+
2. **Already Satisfied**: Packages that were already present and up-to-date
|
|
133
|
+
3. **Warnings**: Important warnings from pip (cleaned and deduplicated)
|
|
134
|
+
4. **Errors**: Any errors encountered (key messages only)
|
|
135
|
+
5. **Dependencies**: All packages that were collected/processed during installation
|
|
136
|
+
|
|
137
|
+
## Why pip-brief?
|
|
138
|
+
|
|
139
|
+
Standard `pip install` output can be verbose and hard to parse quickly. pip-brief provides:
|
|
140
|
+
- Clear separation of different types of information
|
|
141
|
+
- Elimination of redundant messages
|
|
142
|
+
- Easy-to-scan format
|
|
143
|
+
- Focus on what actually happened during installation
|
|
144
|
+
|
|
145
|
+
## Requirements
|
|
146
|
+
|
|
147
|
+
- Python 3.6+
|
|
148
|
+
- pip
|
|
149
|
+
|
|
150
|
+
## License
|
|
151
|
+
|
|
152
|
+
This project is licensed under the MIT License - see the LICENSE file for details.
|
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
# pip-brief
|
|
2
|
+
|
|
3
|
+
A clean, human-readable wrapper for `pip install` that provides organized summaries of installation results.
|
|
4
|
+
|
|
5
|
+
## Features
|
|
6
|
+
|
|
7
|
+
- **Clean Output Format**: Organized summary with numbered sections
|
|
8
|
+
- **Comprehensive Tracking**: Shows installed packages, already satisfied requirements, warnings, errors, and dependencies
|
|
9
|
+
- **Duplicate Removal**: Eliminates repetitive messages for cleaner output
|
|
10
|
+
- **Verbose Mode**: Option to see full pip output when needed
|
|
11
|
+
- **Simple Interface**: Easy-to-use command structure
|
|
12
|
+
|
|
13
|
+
## Installation
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
pip install pip-brief
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## Usage
|
|
20
|
+
|
|
21
|
+
### Install one or more packages with brief summary:
|
|
22
|
+
```bash
|
|
23
|
+
pip-brief install <package-name>
|
|
24
|
+
pip-brief install <package1> <package2> <package3>
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
### Install with verbose output (shows full pip output):
|
|
28
|
+
```bash
|
|
29
|
+
pip-brief install <package-name> --verbose
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
## Example Output
|
|
33
|
+
|
|
34
|
+
### Single Package:
|
|
35
|
+
```
|
|
36
|
+
**Summary of requests installation:**
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
1) Installed:
|
|
40
|
+
requests (2.31.0), urllib3 (2.0.4), certifi (2023.7.22)
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
2) Already Satisfied:
|
|
44
|
+
charset-normalizer, idna
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
3) Dependencies:
|
|
48
|
+
requests, urllib3, certifi, charset-normalizer, idna
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
### Multiple Packages:
|
|
52
|
+
```
|
|
53
|
+
**Summary of loguru installation:**
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
1) Installed:
|
|
57
|
+
loguru (0.7.3)
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
2) Dependencies:
|
|
61
|
+
loguru
|
|
62
|
+
|
|
63
|
+
==================================================
|
|
64
|
+
|
|
65
|
+
**Summary of emoji installation:**
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
1) Installed:
|
|
69
|
+
emoji (2.8.0)
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
2) Dependencies:
|
|
73
|
+
emoji
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
## Output Format
|
|
77
|
+
|
|
78
|
+
The summary is organized into up to 5 sections (only applicable sections are shown):
|
|
79
|
+
|
|
80
|
+
1. **Installed**: Packages that were newly installed
|
|
81
|
+
2. **Already Satisfied**: Packages that were already present and up-to-date
|
|
82
|
+
3. **Warnings**: Important warnings from pip (cleaned and deduplicated)
|
|
83
|
+
4. **Errors**: Any errors encountered (key messages only)
|
|
84
|
+
5. **Dependencies**: All packages that were collected/processed during installation
|
|
85
|
+
|
|
86
|
+
## Why pip-brief?
|
|
87
|
+
|
|
88
|
+
Standard `pip install` output can be verbose and hard to parse quickly. pip-brief provides:
|
|
89
|
+
- Clear separation of different types of information
|
|
90
|
+
- Elimination of redundant messages
|
|
91
|
+
- Easy-to-scan format
|
|
92
|
+
- Focus on what actually happened during installation
|
|
93
|
+
|
|
94
|
+
## Requirements
|
|
95
|
+
|
|
96
|
+
- Python 3.6+
|
|
97
|
+
- pip
|
|
98
|
+
|
|
99
|
+
## License
|
|
100
|
+
|
|
101
|
+
This project is licensed under the MIT License - see the LICENSE file for details.
|
|
File without changes
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
import argparse
|
|
2
|
+
import sys
|
|
3
|
+
from pip_brief.core import run_pip_install, parse_pip_output, format_summary
|
|
4
|
+
|
|
5
|
+
def main():
|
|
6
|
+
parser = argparse.ArgumentParser(description="pip-brief: A clean summary for pip install")
|
|
7
|
+
|
|
8
|
+
# Add subcommands
|
|
9
|
+
subparsers = parser.add_subparsers(dest='command', help='Available commands')
|
|
10
|
+
|
|
11
|
+
# Install command
|
|
12
|
+
install_parser = subparsers.add_parser('install', help='Install packages with brief summary')
|
|
13
|
+
install_parser.add_argument('packages', nargs='+', help='Package name(s) to install')
|
|
14
|
+
install_parser.add_argument('--verbose', action='store_true', help='Show full pip output')
|
|
15
|
+
|
|
16
|
+
args = parser.parse_args()
|
|
17
|
+
|
|
18
|
+
if not args.command:
|
|
19
|
+
parser.print_help()
|
|
20
|
+
sys.exit(1)
|
|
21
|
+
|
|
22
|
+
if args.command == 'install':
|
|
23
|
+
if args.verbose:
|
|
24
|
+
# For verbose mode, install all packages together and show raw output
|
|
25
|
+
raw_output = run_pip_install(args.packages)
|
|
26
|
+
print(raw_output)
|
|
27
|
+
else:
|
|
28
|
+
# For brief mode, install each package separately and show individual summaries
|
|
29
|
+
for i, package in enumerate(args.packages):
|
|
30
|
+
raw_output = run_pip_install([package])
|
|
31
|
+
parsed = parse_pip_output(raw_output)
|
|
32
|
+
summary = format_summary(parsed, package)
|
|
33
|
+
print(summary)
|
|
34
|
+
|
|
35
|
+
# Add spacing between package summaries (except for the last one)
|
|
36
|
+
if i < len(args.packages) - 1:
|
|
37
|
+
print("\n" + "="*50 + "\n")
|
|
38
|
+
|
|
39
|
+
if __name__ == "__main__":
|
|
40
|
+
main()
|
|
@@ -0,0 +1,200 @@
|
|
|
1
|
+
import subprocess
|
|
2
|
+
import re
|
|
3
|
+
|
|
4
|
+
# ANSI color codes for terminal formatting
|
|
5
|
+
class Colors:
|
|
6
|
+
YELLOW = '\033[93m'
|
|
7
|
+
CYAN = '\033[96m'
|
|
8
|
+
GREEN = '\033[92m'
|
|
9
|
+
BLUE = '\033[94m'
|
|
10
|
+
BOLD = '\033[1m'
|
|
11
|
+
END = '\033[0m' # Reset to default color
|
|
12
|
+
|
|
13
|
+
def run_pip_install(packages):
|
|
14
|
+
"""Run pip install command and capture output"""
|
|
15
|
+
if isinstance(packages, str):
|
|
16
|
+
packages = [packages]
|
|
17
|
+
|
|
18
|
+
cmd = ["pip", "install"] + packages
|
|
19
|
+
result = subprocess.run(
|
|
20
|
+
cmd,
|
|
21
|
+
capture_output=True,
|
|
22
|
+
text=True
|
|
23
|
+
)
|
|
24
|
+
return result.stdout + result.stderr
|
|
25
|
+
|
|
26
|
+
def parse_pip_output(output):
|
|
27
|
+
"""Parse pip install output into structured sections"""
|
|
28
|
+
lines = output.splitlines()
|
|
29
|
+
|
|
30
|
+
installed = []
|
|
31
|
+
already_satisfied = []
|
|
32
|
+
warnings = []
|
|
33
|
+
errors = []
|
|
34
|
+
dependencies = []
|
|
35
|
+
|
|
36
|
+
for line in lines:
|
|
37
|
+
line = line.strip()
|
|
38
|
+
|
|
39
|
+
# Skip empty lines
|
|
40
|
+
if not line:
|
|
41
|
+
continue
|
|
42
|
+
|
|
43
|
+
# Parse installed packages
|
|
44
|
+
if "Successfully installed" in line:
|
|
45
|
+
# Extract package names with versions from "Successfully installed package1-1.0.0 package2-2.0.0"
|
|
46
|
+
match = re.search(r"Successfully installed (.+)", line)
|
|
47
|
+
if match:
|
|
48
|
+
packages_raw = match.group(1).split()
|
|
49
|
+
for package in packages_raw:
|
|
50
|
+
# Convert package-version format to package (version) format
|
|
51
|
+
if '-' in package:
|
|
52
|
+
# Split by last dash to separate name and version
|
|
53
|
+
parts = package.rsplit('-', 1)
|
|
54
|
+
if len(parts) == 2:
|
|
55
|
+
name, version = parts
|
|
56
|
+
formatted_package = f"{name} ({version})"
|
|
57
|
+
installed.append(formatted_package)
|
|
58
|
+
else:
|
|
59
|
+
installed.append(package)
|
|
60
|
+
else:
|
|
61
|
+
installed.append(package)
|
|
62
|
+
|
|
63
|
+
# Parse already satisfied packages
|
|
64
|
+
elif "Requirement already satisfied:" in line:
|
|
65
|
+
# Extract package name and version info
|
|
66
|
+
# Example: "Requirement already satisfied: numpy in c:\path (2.2.3)"
|
|
67
|
+
match = re.search(r"Requirement already satisfied:\s+([^\s]+).*?\(([^)]+)\)", line)
|
|
68
|
+
if match:
|
|
69
|
+
package_name = match.group(1)
|
|
70
|
+
version = match.group(2)
|
|
71
|
+
package_info = f"{package_name} ({version})"
|
|
72
|
+
already_satisfied.append(package_info)
|
|
73
|
+
else:
|
|
74
|
+
# Fallback if version not found
|
|
75
|
+
match = re.search(r"Requirement already satisfied:\s+([^\s]+)", line)
|
|
76
|
+
if match:
|
|
77
|
+
package_info = match.group(1)
|
|
78
|
+
already_satisfied.append(package_info)
|
|
79
|
+
|
|
80
|
+
# Parse warnings
|
|
81
|
+
elif "WARNING:" in line:
|
|
82
|
+
# Clean up warning message - remove WARNING: prefix and make it understandable
|
|
83
|
+
warning = line.replace("WARNING:", "").strip()
|
|
84
|
+
|
|
85
|
+
# Simplify common warning messages
|
|
86
|
+
if "Ignoring invalid distribution" in warning:
|
|
87
|
+
# Extract the distribution name and make it readable
|
|
88
|
+
match = re.search(r"Ignoring invalid distribution ([^\s]+)", warning)
|
|
89
|
+
if match:
|
|
90
|
+
dist_name = match.group(1)
|
|
91
|
+
simplified_warning = f"Corrupted package installation detected ({dist_name}) - consider cleaning pip cache"
|
|
92
|
+
if simplified_warning not in warnings:
|
|
93
|
+
warnings.append(simplified_warning)
|
|
94
|
+
else:
|
|
95
|
+
# For other warnings, just clean up and add
|
|
96
|
+
warning = re.sub(r'\s+', ' ', warning) # Normalize whitespace
|
|
97
|
+
if warning and warning not in warnings:
|
|
98
|
+
warnings.append(warning)
|
|
99
|
+
|
|
100
|
+
# Parse errors
|
|
101
|
+
elif "ERROR:" in line:
|
|
102
|
+
# Clean up error message - remove ERROR: prefix
|
|
103
|
+
error = line.replace("ERROR:", "").strip()
|
|
104
|
+
error = re.sub(r'\s+', ' ', error) # Normalize whitespace
|
|
105
|
+
if error and error not in errors:
|
|
106
|
+
errors.append(error)
|
|
107
|
+
|
|
108
|
+
# Parse dependencies (packages being collected/downloaded)
|
|
109
|
+
elif "Collecting" in line:
|
|
110
|
+
match = re.search(r"Collecting\s+([^\s\(]+)", line)
|
|
111
|
+
if match:
|
|
112
|
+
dep = match.group(1)
|
|
113
|
+
if dep not in dependencies:
|
|
114
|
+
dependencies.append(dep)
|
|
115
|
+
|
|
116
|
+
# Remove duplicates while preserving order
|
|
117
|
+
def remove_duplicates(lst):
|
|
118
|
+
seen = set()
|
|
119
|
+
result = []
|
|
120
|
+
for item in lst:
|
|
121
|
+
if item not in seen:
|
|
122
|
+
seen.add(item)
|
|
123
|
+
result.append(item)
|
|
124
|
+
return result
|
|
125
|
+
|
|
126
|
+
return {
|
|
127
|
+
"installed": remove_duplicates(installed),
|
|
128
|
+
"already_satisfied": remove_duplicates(already_satisfied),
|
|
129
|
+
"warnings": remove_duplicates(warnings),
|
|
130
|
+
"errors": remove_duplicates(errors),
|
|
131
|
+
"dependencies": remove_duplicates(dependencies)
|
|
132
|
+
}
|
|
133
|
+
|
|
134
|
+
def format_summary(data, package_name):
|
|
135
|
+
"""Format the final summary according to specified format"""
|
|
136
|
+
lines = []
|
|
137
|
+
|
|
138
|
+
# Determine if installation was successful or failed
|
|
139
|
+
has_installed = len(data["installed"]) > 0
|
|
140
|
+
has_already_satisfied = len(data["already_satisfied"]) > 0
|
|
141
|
+
has_errors = len(data["errors"]) > 0
|
|
142
|
+
|
|
143
|
+
# Choose appropriate title based on success/failure
|
|
144
|
+
if has_errors and not has_installed and not has_already_satisfied:
|
|
145
|
+
title = f"Summary of {package_name} attempt:"
|
|
146
|
+
else:
|
|
147
|
+
title = f"Summary of {package_name} installation:"
|
|
148
|
+
|
|
149
|
+
# Add color formatting to the title
|
|
150
|
+
colored_title = f"{Colors.BOLD}{Colors.CYAN}{title}{Colors.END}"
|
|
151
|
+
underline = "=" * len(title) # Use original title length for underline
|
|
152
|
+
|
|
153
|
+
lines.append(colored_title)
|
|
154
|
+
lines.append(underline)
|
|
155
|
+
lines.append("") # Empty line after underline
|
|
156
|
+
|
|
157
|
+
point_number = 1
|
|
158
|
+
|
|
159
|
+
# 1) Installed
|
|
160
|
+
if data["installed"]:
|
|
161
|
+
lines.append(f"{point_number}) Installed:")
|
|
162
|
+
lines.append(", ".join(data["installed"]))
|
|
163
|
+
lines.append("") # Empty line
|
|
164
|
+
lines.append("") # Second empty line
|
|
165
|
+
point_number += 1
|
|
166
|
+
|
|
167
|
+
# 2) Already Satisfied
|
|
168
|
+
if data["already_satisfied"]:
|
|
169
|
+
lines.append(f"{point_number}) Already Satisfied:")
|
|
170
|
+
lines.append(", ".join(data["already_satisfied"]))
|
|
171
|
+
lines.append("") # Empty line
|
|
172
|
+
lines.append("") # Second empty line
|
|
173
|
+
point_number += 1
|
|
174
|
+
|
|
175
|
+
# 3) Warnings (only show if there was successful activity)
|
|
176
|
+
if data["warnings"] and (has_installed or has_already_satisfied):
|
|
177
|
+
lines.append(f"{point_number}) Warnings:")
|
|
178
|
+
lines.append(", ".join(data["warnings"]))
|
|
179
|
+
lines.append("") # Empty line
|
|
180
|
+
lines.append("") # Second empty line
|
|
181
|
+
point_number += 1
|
|
182
|
+
|
|
183
|
+
# 4) Errors
|
|
184
|
+
if data["errors"]:
|
|
185
|
+
lines.append(f"{point_number}) Errors:")
|
|
186
|
+
lines.append(", ".join(data["errors"]))
|
|
187
|
+
lines.append("") # Empty line
|
|
188
|
+
lines.append("") # Second empty line
|
|
189
|
+
point_number += 1
|
|
190
|
+
|
|
191
|
+
# 5) Dependencies
|
|
192
|
+
if data["dependencies"]:
|
|
193
|
+
lines.append(f"{point_number}) Dependencies:")
|
|
194
|
+
lines.append(", ".join(data["dependencies"]))
|
|
195
|
+
|
|
196
|
+
# Remove trailing empty lines
|
|
197
|
+
while lines and lines[-1] == "":
|
|
198
|
+
lines.pop()
|
|
199
|
+
|
|
200
|
+
return "\n".join(lines)
|
|
@@ -0,0 +1,152 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: pip-brief
|
|
3
|
+
Version: 1.0.0
|
|
4
|
+
Summary: A simple wrapper for pip install with clean, organized output
|
|
5
|
+
Author-email: Nachiket Mehendale <your-email@example.com>
|
|
6
|
+
License: MIT License
|
|
7
|
+
|
|
8
|
+
Copyright (c) 2025 Nachiket Mehendale
|
|
9
|
+
|
|
10
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
11
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
12
|
+
in the Software without restriction, including without limitation the rights
|
|
13
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
14
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
15
|
+
furnished to do so, subject to the following conditions:
|
|
16
|
+
|
|
17
|
+
The above copyright notice and this permission notice shall be included in all
|
|
18
|
+
copies or substantial portions of the Software.
|
|
19
|
+
|
|
20
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
21
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
22
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
23
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
24
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
25
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
26
|
+
SOFTWARE.
|
|
27
|
+
Project-URL: Homepage, https://github.com/Nachiket-Mehendale/pip-brief
|
|
28
|
+
Project-URL: Repository, https://github.com/Nachiket-Mehendale/pip-brief
|
|
29
|
+
Project-URL: Issues, https://github.com/Nachiket-Mehendale/pip-brief/issues
|
|
30
|
+
Keywords: pip,wrapper,cli,package-manager,install,summary
|
|
31
|
+
Classifier: Development Status :: 5 - Production/Stable
|
|
32
|
+
Classifier: Intended Audience :: Developers
|
|
33
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
34
|
+
Classifier: Operating System :: OS Independent
|
|
35
|
+
Classifier: Programming Language :: Python :: 3
|
|
36
|
+
Classifier: Programming Language :: Python :: 3.6
|
|
37
|
+
Classifier: Programming Language :: Python :: 3.7
|
|
38
|
+
Classifier: Programming Language :: Python :: 3.8
|
|
39
|
+
Classifier: Programming Language :: Python :: 3.9
|
|
40
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
41
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
42
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
43
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
44
|
+
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
45
|
+
Classifier: Topic :: System :: Installation/Setup
|
|
46
|
+
Classifier: Topic :: Utilities
|
|
47
|
+
Requires-Python: >=3.6
|
|
48
|
+
Description-Content-Type: text/markdown
|
|
49
|
+
License-File: LICENSE
|
|
50
|
+
Dynamic: license-file
|
|
51
|
+
|
|
52
|
+
# pip-brief
|
|
53
|
+
|
|
54
|
+
A clean, human-readable wrapper for `pip install` that provides organized summaries of installation results.
|
|
55
|
+
|
|
56
|
+
## Features
|
|
57
|
+
|
|
58
|
+
- **Clean Output Format**: Organized summary with numbered sections
|
|
59
|
+
- **Comprehensive Tracking**: Shows installed packages, already satisfied requirements, warnings, errors, and dependencies
|
|
60
|
+
- **Duplicate Removal**: Eliminates repetitive messages for cleaner output
|
|
61
|
+
- **Verbose Mode**: Option to see full pip output when needed
|
|
62
|
+
- **Simple Interface**: Easy-to-use command structure
|
|
63
|
+
|
|
64
|
+
## Installation
|
|
65
|
+
|
|
66
|
+
```bash
|
|
67
|
+
pip install pip-brief
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
## Usage
|
|
71
|
+
|
|
72
|
+
### Install one or more packages with brief summary:
|
|
73
|
+
```bash
|
|
74
|
+
pip-brief install <package-name>
|
|
75
|
+
pip-brief install <package1> <package2> <package3>
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
### Install with verbose output (shows full pip output):
|
|
79
|
+
```bash
|
|
80
|
+
pip-brief install <package-name> --verbose
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
## Example Output
|
|
84
|
+
|
|
85
|
+
### Single Package:
|
|
86
|
+
```
|
|
87
|
+
**Summary of requests installation:**
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
1) Installed:
|
|
91
|
+
requests (2.31.0), urllib3 (2.0.4), certifi (2023.7.22)
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
2) Already Satisfied:
|
|
95
|
+
charset-normalizer, idna
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
3) Dependencies:
|
|
99
|
+
requests, urllib3, certifi, charset-normalizer, idna
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
### Multiple Packages:
|
|
103
|
+
```
|
|
104
|
+
**Summary of loguru installation:**
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
1) Installed:
|
|
108
|
+
loguru (0.7.3)
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
2) Dependencies:
|
|
112
|
+
loguru
|
|
113
|
+
|
|
114
|
+
==================================================
|
|
115
|
+
|
|
116
|
+
**Summary of emoji installation:**
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
1) Installed:
|
|
120
|
+
emoji (2.8.0)
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
2) Dependencies:
|
|
124
|
+
emoji
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
## Output Format
|
|
128
|
+
|
|
129
|
+
The summary is organized into up to 5 sections (only applicable sections are shown):
|
|
130
|
+
|
|
131
|
+
1. **Installed**: Packages that were newly installed
|
|
132
|
+
2. **Already Satisfied**: Packages that were already present and up-to-date
|
|
133
|
+
3. **Warnings**: Important warnings from pip (cleaned and deduplicated)
|
|
134
|
+
4. **Errors**: Any errors encountered (key messages only)
|
|
135
|
+
5. **Dependencies**: All packages that were collected/processed during installation
|
|
136
|
+
|
|
137
|
+
## Why pip-brief?
|
|
138
|
+
|
|
139
|
+
Standard `pip install` output can be verbose and hard to parse quickly. pip-brief provides:
|
|
140
|
+
- Clear separation of different types of information
|
|
141
|
+
- Elimination of redundant messages
|
|
142
|
+
- Easy-to-scan format
|
|
143
|
+
- Focus on what actually happened during installation
|
|
144
|
+
|
|
145
|
+
## Requirements
|
|
146
|
+
|
|
147
|
+
- Python 3.6+
|
|
148
|
+
- pip
|
|
149
|
+
|
|
150
|
+
## License
|
|
151
|
+
|
|
152
|
+
This project is licensed under the MIT License - see the LICENSE file for details.
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
LICENSE
|
|
2
|
+
README.md
|
|
3
|
+
pyproject.toml
|
|
4
|
+
pip_brief/__init__.py
|
|
5
|
+
pip_brief/cli.py
|
|
6
|
+
pip_brief/core.py
|
|
7
|
+
pip_brief.egg-info/PKG-INFO
|
|
8
|
+
pip_brief.egg-info/SOURCES.txt
|
|
9
|
+
pip_brief.egg-info/dependency_links.txt
|
|
10
|
+
pip_brief.egg-info/entry_points.txt
|
|
11
|
+
pip_brief.egg-info/top_level.txt
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
pip_brief
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["setuptools>=64", "wheel"]
|
|
3
|
+
build-backend = "setuptools.build_meta"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "pip-brief"
|
|
7
|
+
version = "1.0.0"
|
|
8
|
+
description = "A simple wrapper for pip install with clean, organized output"
|
|
9
|
+
authors = [
|
|
10
|
+
{ name="Nachiket Mehendale", email="your-email@example.com" }
|
|
11
|
+
]
|
|
12
|
+
dependencies = []
|
|
13
|
+
readme = "README.md"
|
|
14
|
+
license = { file="LICENSE" }
|
|
15
|
+
requires-python = ">=3.6"
|
|
16
|
+
classifiers = [
|
|
17
|
+
"Development Status :: 5 - Production/Stable",
|
|
18
|
+
"Intended Audience :: Developers",
|
|
19
|
+
"License :: OSI Approved :: MIT License",
|
|
20
|
+
"Operating System :: OS Independent",
|
|
21
|
+
"Programming Language :: Python :: 3",
|
|
22
|
+
"Programming Language :: Python :: 3.6",
|
|
23
|
+
"Programming Language :: Python :: 3.7",
|
|
24
|
+
"Programming Language :: Python :: 3.8",
|
|
25
|
+
"Programming Language :: Python :: 3.9",
|
|
26
|
+
"Programming Language :: Python :: 3.10",
|
|
27
|
+
"Programming Language :: Python :: 3.11",
|
|
28
|
+
"Programming Language :: Python :: 3.12",
|
|
29
|
+
"Programming Language :: Python :: 3.13",
|
|
30
|
+
"Topic :: Software Development :: Libraries :: Python Modules",
|
|
31
|
+
"Topic :: System :: Installation/Setup",
|
|
32
|
+
"Topic :: Utilities"
|
|
33
|
+
]
|
|
34
|
+
keywords = ["pip", "wrapper", "cli", "package-manager", "install", "summary"]
|
|
35
|
+
|
|
36
|
+
[project.scripts]
|
|
37
|
+
pip-brief = "pip_brief.cli:main"
|
|
38
|
+
|
|
39
|
+
[project.urls]
|
|
40
|
+
Homepage = "https://github.com/Nachiket-Mehendale/pip-brief"
|
|
41
|
+
Repository = "https://github.com/Nachiket-Mehendale/pip-brief"
|
|
42
|
+
Issues = "https://github.com/Nachiket-Mehendale/pip-brief/issues"
|