Skip to content

sentier-dev/units

Unit utility web app

[Status][pypi status] [Python Version][pypi status] License

[Read the documentation at https://units.readthedocs.io/][read the docs] Tests Codecov security: bandit

pre-commit Black

Web app for unit utilities and conversions.

Shell Utilities for units

tasks.py provides shell utilities for the units project, utilizing invoke for task execution. Below are the tasks available:

Clean Task

Cleans up the project directory by removing specified files and directories.

Usage

invoke clean [--bytecode] [--pytest] [--mypy] [--extra <extra_patterns>]

Options

  • bytecode "-b": Cleans up compiled Python files.
  • pytest "-p": Cleans up pytest cache and coverage files.
  • mypy "-m": Cleans up mypy cache files.
  • extra "-e": Specifies additional directories or files to clean up.

Install Task

Installs the project with optional modes and dependencies.

Usage

invoke install [--editable] [--testing] [--dev] [--report]

Options

  • editable "-e": Installs the project in editable mode.
  • testing "-t": Installs test dependencies.
  • dev "-d": Installs development dependencies.
  • report "-r": Displays the command output.

Precommit Task

Runs pre-commit checks to ensure code quality and consistency.

Usage

invoke precommit

Test Task

Runs unit and integration tests for the project.

Usage

invoke test [--integration] [--report]

Options

  • integration "-i": Runs integration tests.
  • report "-r": Displays the command output.

Contributing

Contributions are very welcome. To learn more, see the Contributor Guide.

License

Distributed under the terms of the BSD-3-Clause, units is free and open source software.

Issues

If you encounter any problems, please file an issue along with a detailed description.

About

No description, website, or topics provided.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages