Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

build: cleaner build process #107

Merged
merged 41 commits into from
Jan 13, 2021
Merged

build: cleaner build process #107

merged 41 commits into from
Jan 13, 2021

Conversation

deepcharles
Copy link
Owner

@deepcharles deepcharles commented Jan 9, 2021

Several developper tools from this Scikit-HEP guide are introduced in this PR.

PEP 517/518

The upload-to-pypi Gh action was still using the legacy python setup.py sdist command. It has been replaced by the newer python -m build --sdist.

More information here.

MANIFEST.in

MANIFEST.in controls the set of files that are included in sdist distributions. Before, many configurations files, and documentation were included. Now, only src/, tests/ and a few other files are included.

More information here.

Versioning

The package version is now derived from the latest git tag, the latest commit and the date of build, thanks to the setuptools_scm package. The versioning scheme is decribed here. Now, we only need to add an appropriate tag (following semantic versioning) to bump the version.

More information here.

Pre-commit hooks

Pre-commit hooks have been updated using pre-commit autoupdate.

Documentation

The build and install procedures have updated in the various places of the documentation.

@github-actions github-actions bot added the Type: Build Bug fix to a build script label Jan 9, 2021
@codecov
Copy link

codecov bot commented Jan 9, 2021

Codecov Report

Merging #107 (86a634f) into master (306efb5) will increase coverage by 6.08%.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #107      +/-   ##
==========================================
+ Coverage   86.68%   92.77%   +6.08%     
==========================================
  Files          41       41              
  Lines         954      955       +1     
==========================================
+ Hits          827      886      +59     
+ Misses        127       69      -58     
Impacted Files Coverage Δ
src/ruptures/__init__.py 100.00% <100.00%> (ø)
src/ruptures/costs/costclinear.py 100.00% <100.00%> (+65.21%) ⬆️
src/ruptures/datasets/pw_constant.py 100.00% <100.00%> (ø)
src/ruptures/costs/costcosine.py 100.00% <0.00%> (+59.25%) ⬆️
src/ruptures/costs/costlinear.py 100.00% <0.00%> (+60.00%) ⬆️
src/ruptures/costs/costml.py 100.00% <0.00%> (+62.50%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 306efb5...86a634f. Read the comment docs.

Copy link
Collaborator

@oboulant oboulant left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM
Very nice clean work ! 👏

oboulant and others added 13 commits January 10, 2021 14:25
* docs(costlinear): typo

* test(costlinear): add test for CostLinear

* docs: typo

* test(costlinear): Make tests simplier and more integrated

* test(costlinear): typo

* test(costlinear): use simplier np.c_

Co-authored-by: Charles T <[email protected]>
* test(CostMl, CostCosine): Add test, delete duplicate functions, set random seed

* refactor(pw_constant): inject seed for reproducible random state

* test(test_costs): set random seed

* test(test_costs): running black

* test(costlinear): fix an import mishandled by merge with master
add an input field in the gh action to override the version number
This file is generated by setuptools_scm
@deepcharles
Copy link
Owner Author

The GHA Check linting is replaced by the Github Application results.pre-commit.ci. It relies only the .pre-commit-config.yaml for the configuration. The check is faster (dependencies are cached) that way.

@deepcharles deepcharles merged commit 4049575 into master Jan 13, 2021
@deepcharles deepcharles deleted the build/clean-build-process branch January 13, 2021 12:42
@deepcharles deepcharles restored the build/clean-build-process branch February 1, 2021 18:41
@deepcharles deepcharles deleted the build/clean-build-process branch September 17, 2021 12:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Build Bug fix to a build script
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants