# \[ANN\] PackageAnalyzer v1.0 **URL:** \ **Category:** Package Announcements\ **Created:** [November 25, 2022, 6:08pm UTC](https://discourse.julialang.org/t/ann-packageanalyzer-v1-0/90824 "2022-11-25T18:08:03Z")\ **Posts on this page:** 4\ **Page:** 1

**Author:** ![ericphanson](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/ericphanson/32/215186_2.png) [@ericphanson](https://discourse.julialang.org/u/ericphanson)\ **Post date:** [November 25, 2022, 6:08pm UTC](https://discourse.julialang.org/t/ann-packageanalyzer-v1-0/90824/1 "2022-11-25T18:08:04Z")

[PackageAnalyzer](https://github.com/JuliaEcosystem/PackageAnalyzer.jl) is a tool @giordano created while writing [this awesome blog post](https://giordano.github.io/blog/2021-01-23-documentation-testing-julia/). After that, I helped expand some of the functionality, and together we used the tool to survey the General registry, resulting in this [blog post](https://julialang.org/blog/2021/08/general-survey/) and [2021 JuliaCon talk](https://www.youtube.com/watch?v=9YWwiFbaRx8&feature=youtu.be). Recently, we updated the package with a bit more functionality and cut a v1.0 release. ## What can PackageAnalyzer do? PackageAnalyzer downloads the code associated to a package, and runs some very basic static analysis, looking for the presence of CI scripts & documentation, counting lines of source code and tests, and checking licenses. It also optionally can gather contributor data from the GitHub API. It is multithreaded, robust and somewhat battle-hardened, as Mosè ran PackageAnalyzer v0.1 daily on the whole General registry for a long time to collect statistics over time. Note that a lot of internals have changed in v1.0, so it is possible it has regressed on its “battle-hardened” status, although we have tried to keep in mind the lessons learned from earlier versions 🙂. The API is very simple; one calls `analyze("DataFrames")` for example to analyze the package `DataFrames`: ```julia julia> analyze("DataFrames") Package DataFrames: * repo: https://github.com/JuliaData/DataFrames.jl.git * uuid: a93c6f00-e57d-5684-b7b6-d8193f3e46c0 * version: 1.4.3 * is reachable: true * tree hash: 0f44494fe4271cc966ac4fea524111bef63ba86c * Julia code in `src`: 18778 lines * Julia code in `test`: 28766 lines (60.5% of `test` + `src`) * documentation in `docs`: 6761 lines (26.5% of `docs` + `src`) * documentation in README: 21 lines * has license(s) in file: MIT * filename: LICENSE.md * OSI approved: true * has `docs/make.jl`: true * has `test/runtests.jl`: true * has continuous integration: true * GitHub Actions ``` PackageAnalyzer uses [RegistryInstances.jl](https://github.com/GunnarFarneback/RegistryInstances.jl), which is based on code taken from Pkg.jl, in order to query all installed registries for the package name, and thus supports multiple registries. The input to `analyze` can also be a local path or a URL. One can also analyze an entire manifest with `analyze_manifest(path)` (where `path` defaults to the manifest of the current active project). For example, analyzing a temporary environment in which I’ve added `PackageAnalyzer` ```julia pkg> activate --temp pkg> add PackageAnalyzer julia> using PackageAnalyzer julia> @time results = analyze_manifest(); 0.117077 seconds (317.67 k allocations: 43.424 MiB) julia> summary(results) "33-element Vector{PackageAnalyzer.Package}" ``` PackageAnalyzer will respect the versions of each dependency in the Manifest, meaning it will take care to analyze the associated code (and not, say, the latest development code). It also properly handles code on branches (from e.g. `Pkg.add(; rev=...)`) and `dev`’d dependencies. It will download code if required, but if the code already exists in your `.julia` folder, it will find and use that (and verify the git tree hash to ensure the contents are as expected according to the hash in the manifest or registry). This makes analyzing manifests which have been `instantiate`’d very quick. One can easily post-process the results, since a `Vector{PackageAnalyzer.Package}` is a Tables.jl-compatible row table. Continuing the example above, ```julia pkg> add DataFrames julia> using DataFrames julia> df = DataFrame(results) 33×22 DataFrame Row │ name uuid repo subdir reachable docs runtests github_actions travis appve ⋯ │ String Base.UUID String String Bool Bool Bool Bool Bool Bool ⋯ ─────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── 1 │ libsodium_jll a9144af2-ca23-56d9-984f-0d03f7b5… https://github.com/JuliaBinaryWr… true false false false false fa ⋯ 2 │ HTTP cd3eb016-35fb-5094-929b-558a96fa… https://github.com/JuliaWeb/HTTP… true true true true false fa 3 │ licensecheck_jll 4ecb348a-8b88-51ea-b912-4c460483… https://github.com/JuliaBinaryWr… true false false false false fa 4 │ PackageAnalyzer e713c705-17e4-4cec-abe0-95bf5bf3… https://github.com/JuliaEcosyste… true true true true false fa ⋮ │ ⋮ ⋮ ⋮ ⋮ ⋮ ⋮ ⋮ ⋮ ⋮ ⋮ ⋱ 31 │ RegistryInstances 2792f1a3-b283-48e8-9a74-f99dce51… https://github.com/GunnarFarneba… true false true true false fa ⋯ 32 │ LazilyInitializedFields 0e77f7df-68c5-4e49-93ce-4cd80f55… https://github.com/KristofferC/L… true false true true false fa 33 │ LicenseCheck 726dbf0d-6eb6-41af-b36c-cd770e0f… https://github.com/ericphanson/L… true false true true false fa 13 columns and 26 rows omitted julia> code = select!(flatten(df, :lines_of_code), :name, :version, :lines_of_code => identity => AsTable); julia> sort!(code, :code) 235×9 DataFrame Row │ name version directory language sublanguage files code comments blanks │ String VersionN… String Symbol Union… Int64 Int64 Int64 Int64 ─────┼───────────────────────────────────────────────────────────────────────────────────────────────────────── 1 │ libsodium_jll 1.0.20+0 README.md Markdown 1 0 27 11 2 │ HTTP 1.5.5 docs Markdown 5 0 465 191 3 │ HTTP 1.5.5 README.md Markdown 1 0 51 29 4 │ HTTP 1.5.5 CHANGELOG.md Markdown 1 0 218 24 5 │ HTTP 1.5.5 LICENSE.md Markdown 1 0 22 2 6 │ licensecheck_jll 0.3.101+0 README.md Markdown 1 0 33 16 7 │ PackageAnalyzer 1.0.0 docs Markdown 3 0 90 40 8 │ PackageAnalyzer 1.0.0 README.md Markdown 1 0 22 13 ⋮ │ ⋮ ⋮ ⋮ ⋮ ⋮ ⋮ ⋮ ⋮ ⋮ 228 │ MbedTLS 1.1.7 src Julia 13 2289 48 237 229 │ JSON3 1.12.0 src Julia 10 2512 68 199 230 │ OpenSSL 1.3.2 src Julia 2 2918 219 521 231 │ Parsers 2.5.1 src Julia 9 3252 136 154 232 │ HTTP 1.5.5 test Julia 26 4537 185 488 233 │ URIs 1.4.1 test JSON 1 4771 0 0 234 │ LazilyInitializedFields 1.2.0 page CSS 94 5944 810 1167 235 │ HTTP 1.5.5 src Julia 36 6712 459 725 219 rows omitted ``` There are plenty more features and analyses that could be added to the package, so check out the [issue tracker](https://github.com/JuliaEcosystem/PackageAnalyzer.jl/issues) if you would like to get involved! We hope others find it a useful way to get a quantitative understanding of their dependencies, as well as of the OSS ecosystem as a whole. ---

**Author:** ![PetrKryslUCSD](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/petrkryslucsd/32/215825_2.png) [@PetrKryslUCSD](https://discourse.julialang.org/u/PetrKryslUCSD)\ **Post date:** [November 25, 2022, 6:16pm UTC](https://discourse.julialang.org/t/ann-packageanalyzer-v1-0/90824/2 "2022-11-25T18:16:31Z")

> [@ericphanson](#): > > `analyze("DataFrames")` What does ```julia julia> analyze("DataFrames") ERROR: ArgumentError: collection must be non-empty ``` mean? ---

**Author:** ![ericphanson](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/ericphanson/32/215186_2.png) [@ericphanson](https://discourse.julialang.org/u/ericphanson)\ **Post date:** [November 25, 2022, 6:20pm UTC](https://discourse.julialang.org/t/ann-packageanalyzer-v1-0/90824/3 "2022-11-25T18:20:35Z")

> [@PetrKryslUCSD](#): > > ```julia > ERROR: ArgumentError: collection must be non-empty > > ``` Well, that shouldn’t happen. Do you have PackageAnalyze v1.0 loaded? What is the full stacktrace? ---

**Author:** ![PetrKryslUCSD](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/petrkryslucsd/32/215825_2.png) [@PetrKryslUCSD](https://discourse.julialang.org/u/PetrKryslUCSD)\ **Post date:** [November 25, 2022, 6:23pm UTC](https://discourse.julialang.org/t/ann-packageanalyzer-v1-0/90824/4 "2022-11-25T18:23:47Z")

Curious: just `add`ing `PackageAnalyzer` only installs 0.1.0. I have to do an update to get 1.0.0. Now it works!