Skip to content

Use more helpful package tools #950

@CasperWA

Description

@CasperWA

In the OPTIMADE Gateway I've started using more package tools to cover issues that may occur with regards to security, static typing and linting.

I've essentially implemented CI and pre-commit hooks for bandit, safety, pylint, and mypy, along with keeping black and removing flake8.

These tools try to ensure we don't implement exploitable holes in the server, as well as make sure the types we write for parameters match up with what is used. safety also checks known vulnerability issues for our dependencies.

Furthermore, as is seen in the FastAPI repository itself, we can combine a lot of repo config and setup files into pyproject.toml, and only use that one file; nice! :)

Essentially, this issue represents a "clean up" of the repository, to keep ourselves in check, try to get better development and PRs, as well as ensure we provide a good and safe package for end-users.

Metadata

Metadata

Assignees

No one assigned

    Labels

    CIContinuous Integration - GitHub Actions issues (NOT related to the repository Action)enhancementNew feature or requestergonomicsFeatures that improve the usability of the packagegood first issueGood for newcomershelp wantedExtra attention is neededneeds discussionpriority/lowIssue or PR with a consensus of low priorityquestionFurther information is requestedsecurityPull requests that address a security vulnerabilitysuggestions

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions