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

Improve tooling for maintenance #79

Merged
merged 10 commits into from
Apr 28, 2022
Merged

Improve tooling for maintenance #79

merged 10 commits into from
Apr 28, 2022

Conversation

smithara
Copy link
Member

These changes introduce two main things to move toward easier maintenance, inspired by https://github.com/scikit-hep/cookie:

  • Add linting configured with .pre-commit-config.yml
    • This is optional for contributors, while I can simply apply it during a PR (or maybe automatically with https://pre-commit.ci/). There's several tools configured there but most important is black to enforce a standard code style.
  • Modernise packaging to use flit and pyproject.toml
    • (also: ./viresclient/ is moved to ./src/viresclient/ and ./test/ to ./tests/)
    • A downside with flit is that it does not come with an automatic versioning system like setuptools_scm
  • Switch dependencies to always accept higher versions (to be mitigated by running a weekly(?) test)

Some things to be added in the future:

  • proper test suite to cover integration with the server, and regression checks
  • type annotations and checking with mypy (?)

smithara and others added 10 commits February 8, 2022 21:46
Merge to master branch to prepare next release
Allow Jinja2 v3 in installation (#74)
* new version of pandas has new option which contains max_rows, need to specify full option path to make sure no ambivalence is possible

* Version to 0.10.2-alpha

Co-authored-by: Ashley Smith <ashley.smith@magneticearth.org>
@pacesm
Copy link
Collaborator

pacesm commented Apr 28, 2022

Looks okay to me.

@smithara smithara merged commit fca309f into staging Apr 28, 2022
@smithara smithara deleted the maint_rework branch May 3, 2022 20:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants