moelf/analyzeregistry.jl

AnalyzeRegistry

Package to analyze the prevalence of documentation, testing and continuous integration in Julia packages in a given registry.

Installation

The package works on Julia v1.6 and following versions. NOTE: the package requires having Git installed and available in the PATH.

To install the package, in Julia's REPL, press ] to enter the Pkg mode and run the command

add https://github.com/giordano/AnalyzeRegistry.jl

Alternatively, you can run

using Pkg
Pkg.add("https://github.com/giordano/AnalyzeRegistry.jl")

Usage

The main functionality of the package is the analyze function:

julia> analyze(joinpath(general_registry(), "F", "Flux"))
Package Flux:
  * repo: https://github.com/FluxML/Flux.jl.git
  * is reachable: true
  * has documentation: true
  * has tests: true
  * has continuous integration: true
    * GitHub Actions
    * Buildkite

The argument is the path to the directory of the package in the registry, where the file Package.toml is stored. The function general_registry() gives you the path to the local copy of the General registry.

NOTE: the Git repository of the package will be cloned, in order to inspect its content.

The returned value is the struct Package, which has the following fields:

struct Package
    name::String # name of the package
    repo::String # URL of the repository
    reachable::Bool # can the repository be cloned?
    docs::Bool # does it have documentation?
    runtests::Bool # does it have the test/runtests.jl file?
    github_actions::Bool # does it use GitHub Actions?
    travis::Bool # does it use Travis CI?
    appveyor::Bool # does it use AppVeyor?
    cirrus::Bool # does it use Cirrus CI?
    circle::Bool # does it use Circle CI?
    drone::Bool # does it use Drone CI?
    buildkite::Bool # does it use Buildkite?
    azure_pipelines::Bool # does it use Azure Pipelines?
    gitlab_pipeline::Bool # does it use Gitlab Pipeline?
end

To run the analysis for multiple packages you can either use broadcasting

analyze.(packages)

or use the method analyze(packages::AbstractVector{<:AbstractString}) which leaverages FLoops.jl to run the analysis with multiple threads.

You can use the function find_packages to find all packages in a given registry:

julia> find_packages(general_registry())
4312-element Vector{String}:
 "/home/user/.julia/registries/General/C/CitableImage"
 "/home/user/.julia/registries/General/T/Trixi2Img"
 "/home/user/.julia/registries/General/I/ImPlot"
 "/home/user/.julia/registries/General/S/StableDQMC"
 "/home/user/.julia/registries/General/S/Strapping"
 [...]

Do not abuse of this function!

License

The AnalyzeRegistry.jl package is licensed under the MIT "Expat" License. The original author is Mosè Giordano.