Data

Tools

Indexes

Applications

Experiments

Open Source Science

extendedlocalcoverage.jl

https://github.com/disberd/extendedlocalcoverage.jl

Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (14.4%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Basic Info
  • Host: GitHub
  • Owner: disberd
  • License: mit
  • Language: Julia
  • Default Branch: main
  • Size: 395 KB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 1
  • Releases: 0
Created about 1 year ago · Last pushed 7 months ago
Metadata Files
Readme Changelog License Code of conduct Citation

README.md

ExtendedLocalCoverage

Stable Documentation In development documentation Build Status Test workflow status Lint workflow Status Docs workflow Status Coverage DOI Contributor Covenant All Contributors BestieTemplate

This package simply extends the functionality of LocalCoverage.jl by adding the following features: - Automatically extract the source files for the provided package using Revise.parse_pkg_files. - Automatically create an xml cobertura coverage and an html report using pycobertura. - The pycobertura library is automatically installed and used thanks to CondaPkg.jl and PythonCall.jl, not requiring the user to manually install python or lcov which is only available on non-windows systems.

You can see an example of the generated HTML coverage report here, which was generated by calling generate_package_coverage(; force_paths_relative = true) on the PlutoPlotly.jl package.

Installation

The package is not currently registered in General, so you need to add it to your environment by doing: julia ] add https://github.com/disberd/ExtendedLocalCoverage.jl or julia import Pkg Pkg.add(url="https://github.com/disberd/ExtendedLocalCoverage.jl")

Usage

For the basic usage which automatically extracts source files (including extensions) and generates the coverage report both in xml and html format, you can simply do the following (within the env of the package you are developing and making sure you have ExtendedLocalCoverage.jl in the LOAD_PATH): julia using ExtendedLocalCoverage generate_package_coverage()

See the developer documentation for more details.

How to Cite

If you use ExtendedLocalCoverage.jl in your work, please cite using the reference given in CITATION.cff.

Contributing

If you want to make contributions of any kind, please first that a look into our contributing guide directly on GitHub or the contributing page on the website

Contributors

Owner

  • Name: Alberto Mengali
  • Login: disberd
  • Kind: user
  • Company: European Space Agency

Citation (CITATION.cff) 

# Go to https://citation-file-format.github.io/cff-initializer-javascript/#/ to finish this
cff-version: 1.2.0
title: ExtendedLocalCoverage.jl
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Alberto Mengali
    email: a.mengali@gmail.com

GitHub Events

Total
  • Delete event: 2
  • Issue comment event: 1
  • Push event: 39
  • Pull request event: 5
  • Create event: 6
Last Year
  • Delete event: 2
  • Issue comment event: 1
  • Push event: 39
  • Pull request event: 5
  • Create event: 6

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 0
  • Total pull requests: 5
  • Average time to close issues: N/A
  • Average time to close pull requests: about 2 months
  • Total issue authors: 0
  • Total pull request authors: 2
  • Average comments per issue: 0
  • Average comments per pull request: 0.2
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 5
Past Year
  • Issues: 0
  • Pull requests: 5
  • Average time to close issues: N/A
  • Average time to close pull requests: about 2 months
  • Issue authors: 0
  • Pull request authors: 2
  • Average comments per issue: 0
  • Average comments per pull request: 0.2
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 5
View more stats
Top Authors
Issue Authors
Pull Request Authors
  • github-actions[bot] (4)
  • dependabot[bot] (1)
Top Labels
Issue Labels
Pull Request Labels
chore (4) dependencies (1)

Dependencies

.github/workflows/Test.yml actions
.github/workflows/TestOnPRs.yml actions
.github/workflows/Docs.yml actions
  • actions/checkout v4 composite
  • julia-actions/cache v2 composite
  • julia-actions/setup-julia v2 composite
.github/workflows/ReusableTest.yml actions
  • actions/checkout v4 composite
  • codecov/codecov-action v4 composite
  • julia-actions/cache v2 composite
  • julia-actions/julia-buildpkg v1 composite
  • julia-actions/julia-processcoverage v1 composite
  • julia-actions/julia-runtest v1 composite
  • julia-actions/setup-julia v2 composite
.github/workflows/TagBot.yml actions
  • JuliaRegistries/TagBot v1 composite
.github/workflows/Lint.yml actions
  • actions/cache v4 composite
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
  • julia-actions/cache v2 composite
  • julia-actions/setup-julia v2 composite
  • lycheeverse/lychee-action v2 composite
.github/workflows/PreCommitUpdate.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
  • peter-evans/create-pull-request v7 composite
.github/workflows/CompatHelper.yml actions
  • julia-actions/cache v2 composite
  • julia-actions/setup-julia v2 composite