Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
bnkc committed Apr 11, 2024
1 parent 0a40980 commit 138e559
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,14 @@ To achieve those, **Unpack**:
+ Identifies local site-package dependencies as to not accidently remove actively used dependencies of other packages.
+ Calculates package(s) size, and total disk usage.


> [!NOTE]
> Unpack started as an exercise to learn Rust. If you are a [rustacean](https://rustacean.net/), you'll find an abundance of
> bugs, defects, and bottlenecks. If you come across anything, please open an [issue](https://github.com/bnkc/unpack/issues)
> so I can learn and grow. Thanks!


### Package States

+ `-used` is when the package is locally installed, one of it's aliases is actively used in the project, and a corresponding dependency is declared in `pyproject.toml` or `requirements.txt`. This state indicates a fully integrated and properly managed package.
Expand Down Expand Up @@ -76,12 +84,10 @@ cargo install un-pack --locked
```




> [!NOTE]
> [!WARNING]
> There are scenarios where using `Unpack` can yield false positives. Mapping `site-packages` to their corresponding
> dependencies/imports are not always a 1:1 relationship. For Example: `scikit-learn` is imported as `sklearn`.
> Alot of decisions were made based on [PEP](https://peps.python.org/pep-0566/)
> Alot of decisions were made based on [Metadata for Python Software Packages](https://peps.python.org/pep-0566/)
### Command-line options

Expand Down

0 comments on commit 138e559

Please sign in to comment.