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

Leverage remote schemas by version number; test constraints #30

Merged
merged 32 commits into from
Jun 14, 2023
Merged

Leverage remote schemas by version number; test constraints #30

merged 32 commits into from
Jun 14, 2023

Conversation

e-lo
Copy link
Owner

@e-lo e-lo commented Jun 13, 2023

This PR provides the functionality to validate against a remote schema hosted on github by github reference (e.g. master HEAD, version tag, etc.). It also pulls out a "spec" as a class object to make it easier to pass around and abstract the differences between getting a spec from Github vs Local files.

This PR also:

  • formats code per pre-commit
  • refactors apply_schema_to_df into smaller functions
  • updates errors and warning to be more helpful (pointing to files, etc)
  • adds tests for field constraints in constraint_tests.py
  • adds assert statements to basic_tests.py

Code Submission Checklist

  • All public API changes, usage, and architecture changes are documented
  • All functions and modules have been documented using google-style docstrings
  • Code and documentation linted: pre-commit run --all-files
  • Code for this PR is covered in tests
  • Code passes all tests: pytest ❗ Tests that are not passing are due to errors in main spec repo. PRs correcting errors have been submitted for review.
  • By contributing to this project, all contributors certify to the Developer Certificate of Origin in CONTRIBUTING.md.

Documentation Submission Checklist

  • Documentation can be built locally mkdocs build
  • Documentation has been reviewed locally mkdocs serve
  • By contributing to this project, all contributors certify to the Developer Certificate of Origin in CONTRIBUTING.md.

Issues List

e-lo added 30 commits June 8, 2023 11:40
@e-lo
Transfers documentation to mkdocs + adds contribution guidelines
863644b 
Also:
- adds code of conduct
- adds contributors
- updates github workflows
@e-lo
Merge pull request #21 from e-lo/mkdocs
5e0d170 
- Transfers documentation to mkdocs
- Adds contribution guidelines
- Adds code of conduct
- Adds contributors
- Updates github workflows

Closes #19 and #20
@e-lo
add issue templates.
bebde0b
@e-lo
Add pull request template
14576ff
@e-lo
Update all docstrings to be google docs style
ce58c69
@e-lo
Precommit, Linting + Fixing
42cca9e 
- templates are md not yaml
- leverage pre-commit
- lints json
@e-lo
update isort pre-commit version
c37336a
@e-lo
update workflows for better branch ref
fa6d234
@e-lo
try updated env var GITHUB_REF_NAME
3d51f9f 
Also:
- rename master --> main
@e-lo
more troubleshooting
eb2954f
@e-lo
try other refs
9ccc785
@e-lo
try again
d4b9dbb
@e-lo
add clean-docs
7072743
@e-lo
try relative import
433d83d
@e-lo
try more absolute import
5696ce1
@e-lo
try explicit module listing
e5a689d
@e-lo
more troubleshooting
0a2fecf 
- remove PR's from package releases
- fix capitalization of CONTRIBUTORS
- add logging; split up steps
@e-lo
update gh-action versions
5b6d3b8
@e-lo
add troubleshooting log
38abbd6
@e-lo
try removing fetch depth?
4d71350
@e-lo
try reverting to checkout v2
6f1753b
@e-lo
rm pull_request; backout to python action v2
bdc6d3f
@e-lo
Merge pull request #24 from e-lo/PR-issue-templates
a1c7925 
- adds Workflows for doc gen, linting and testing
- updates docs to mkdocs
- adds governance, contribution guideines
- adds PR and issue templates
- adds pre-commit and linting

Closes: #22 #23 #21
@e-lo
Deleting clean docs gh action because it is no longer needed
c18d13a 
Since docs aren't being built on PRs right now, this isn't needed.
@e-lo
Adds ability to grab and use official spec by version
8ef2b63 
Add GitHubFile, SpecConfig classes.
Structure there. Need to add/update tests and test test test.
@e-lo
Debug tests
48c4946
@e-lo
Add constraint tests
2107811 
And refactor constraint checking
@e-lo
🐛 fixes
525d91c
@e-lo
Update test_basic.py
40899a8
@e-lo
run black
eebbb35
@e-lo e-lo self-assigned this Jun 13, 2023
@e-lo
update documentation to run cleaner
b92fa8e 
- also add mermaid ERD diagrams
@e-lo e-lo changed the base branch from main to develop June 14, 2023 00:34
@e-lo e-lo merged commit 2918316 into develop Jun 14, 2023
@e-lo e-lo deleted the remote-schemas branch June 14, 2023 00:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@e-lo e-lo

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

🚀 Validate by Spec Version Number 🚀 Pull spec from official repo
1 participant
@e-lo