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.

Sign up for GitHub

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

Jump to bottom

Create a robust Pipy build of OST #67

Merged
merged 31 commits into from
Dec 15, 2021
Merged

Create a robust Pipy build of OST #67

merged 31 commits into from
Dec 15, 2021

Conversation

12rambau
Copy link
Collaborator

@12rambau 12rambau commented Dec 10, 2021 •
edited
Loading

just a draft to summarize what I want to acomplish here:

  • create a minimal setup that can be installed everywhere without issue
  • lint the lib (Flake8 Black)
  • create hooks to force developers to respect these conventions (most of the problems are solved automatically by these hooks)
  • vendor snap
  • debug some tests and manage to run them in a venv
  • manage local tests with tox
  • create github actions to run the test on push and PR
  • send a coverage report to codecov (the first one will be bad like real bad)
  • build a documentation of the API content using sphinx (I think I'll go with the faro template)
  • trigger a rebuild f the doc on PR
  • include the notebooks in the doc

Fix #66 #56 #55 #54

@12rambau
build: update setup.py
47ba38f
@12rambau
build: install pre-commit hooks
e796461 
black linter for every file type (.py and .ipynb)
nbstripout to empty the notebooks
flake8 for PEP compatibility
commitizen to force developer to use standrds commits
@12rambau
refactor: compliant with PEP and Black
fce584c
@12rambau
drop import gdal
0da2623 
Fix #65
@12rambau
build: light distribution that can be build everywhere
f6a362c
@12rambau
build: install all hooks
07afacc 
comitizen was not installed
@12rambau
docs: proudly add our new badges
95711d9
@12rambau
test: skip all test
f1d02cc 
None of them are currently running in our build
Let's fix it it once the build is complete
@12rambau
build: build codecoverage along the tests
fdb55d5
@12rambau
docs: init the documentation
0606a71
@12rambau
docs: setup first pages
2c1c1b4
@12rambau
Copy link
Collaborator Author

when you install rasterio There is a specific pre-compiled build of GDAL that comes with the wheel. That is usually working on modern platform

@12rambau
Copy link
Collaborator Author

first draft of the doc: https://opensartoolkit.readthedocs.io/en/build/

@12rambau 12rambau marked this pull request as ready for review December 13, 2021 22:32
@codecov-commenter
Copy link

codecov-commenter commented Dec 14, 2021 •
edited
Loading

Codecov Report

❗ No coverage uploaded for pull request base (main@86607f2). Click here to learn what that means.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main      #67   +/-   ##
=======================================
  Coverage        ?   15.30%           
=======================================
  Files           ?       37           
  Lines           ?     4732           
  Branches        ?        0           
=======================================
  Hits            ?      724           
  Misses          ?     4008           
  Partials        ?        0

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 86607f2...34a093c. Read the comment docs.

@BuddyVolly BuddyVolly merged commit 721e1bc into main Dec 15, 2021
@12rambau 12rambau deleted the build branch December 15, 2021 09:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

reduce the number of dependencies
3 participants
@12rambau @codecov-commenter @BuddyVolly