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

Refactor Project #59

Closed
wants to merge 26 commits into from
Closed

Refactor Project #59

wants to merge 26 commits into from

Conversation

felixhoffmnn
Copy link

@felixhoffmnn felixhoffmnn commented Nov 17, 2022 •
edited

Description

This PR includes potential breaking changes!

Overview

  • Removed old project config files (python, sphinx / docs, and unit tests)
  • Added config files (IDE, VS Code, pytest, codecov, formatting, linting, pre-commit, prettier, cspell, readthedocs, and poetry)
  • Updated GitHub Actions CI pipeline
  • Switched from sphinx to mkdocs
  • Improved typing for all functions
  • Added partial logging
  • Refactored library functions
  • Moved vvs data

Test Plan

  • The core functionality should not have changed
  • But the test coverage is very low (To-dos need to be revisited)

Checklist

  • Connected regarding GitHub issues and discussions
  • Added docstrings for all new functions
  • Checked CI pipeline for any failures
  • Run pytests locally to check for any failures

@felixhoffmnn
🔧 Added config files and updated gitignore
91a054d
@felixhoffmnn
📝 Removed sphinx documentation and updated readme
443b595
@felixhoffmnn
🚧 Removed old python configuration and added poetry
09520df
@felixhoffmnn
👷 Updated CI pipeline, added pre-commit and updated codeowners
2047bf6
@felixhoffmnn
🏗️ Switched from unittest to pytest and moved
7225039
@felixhoffmnn
🎨 Improved typing, docstrings, and structure of code
59d9db4
@felixhoffmnn
📝 Added mkdocs and refactored documentation from sphinx to mkdocs
1d049cf
@felixhoffmnn
♻️ Extracted get_request() to simplify the typing
98ba2e0
@felixhoffmnn
🚚 Moved obj to models
83421b1
@felixhoffmnn
🚚 Moved test data and vvs data into data/
ce754a3
@felixhoffmnn
📝 Moved files, added example section, and added multiple mkdocs exten…
1d0eddf 
…sions
@felixhoffmnn
🔧 Fixed pre-commit and updated pytest CI
1759220
@felixhoffmnn
💚 Fixed python version for pytest CI
9d793bd
@felixhoffmnn
🚧 Switched python 3.10 typing back to the typing package and updated …
80da217 
…docstrings
@felixhoffmnn
📝 Added configuration for readthedocs
00c0785
@felixhoffmnn
🔧 Updated poetry requirements.txt export and readthedocs
a4ea4db
@felixhoffmnn
🏷️ Switched from loguru to default logging and updated typing in …
cad8ce0 
…docstrings
@felixhoffmnn
🚧 Removed jupyter notebook and downgraded to python 3.7
9dd791f
@felixhoffmnn
🩹 Removed mkdocs-jupyter from mkdocs.yaml and fixed docstrings
e382091
@felixhoffmnn
📝 Updated mkdocstrings for Models
fa2a0f9
@felixhoffmnn
📝 Added highlighting for code blocks
5226d70
felixhoffmnn
felixhoffmnn commented Nov 17, 2022
View reviewed changes
.github/CODEOWNERS Outdated Show resolved Hide resolved
@felixhoffmnn felixhoffmnn marked this pull request as ready for review November 17, 2022 17:08
zaanposni
zaanposni requested changes Nov 19, 2022
View reviewed changes
vvspy/trips.py Outdated Show resolved Hide resolved
.github/CODEOWNERS Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@zaanposni zaanposni Awaiting requested review from zaanposni zaanposni is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
2 participants
@felixhoffmnn @zaanposni