Skip to content

elixir-cloud-aai/cloud-storage-handler

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Jul 9, 2024
191b0fb · Jul 9, 2024

History

16 Commits
Jul 9, 2024
Jul 9, 2024
Jul 2, 2024
Jul 3, 2024
Jul 3, 2024
Jul 9, 2024
Jul 8, 2024
Jul 8, 2024
Jul 2, 2024
Jul 2, 2024
Jul 2, 2024
Jul 3, 2024
Jul 3, 2024
Jul 9, 2024
Jul 8, 2024
Jul 9, 2024
Jul 8, 2024
Jul 9, 2024

Repository files navigation

Bandit codecov Documentation Status License Python 3.11 GitHub contributors Ruff Safety

tus-storagehandler

File handler utilizing TUS and MinIO with DRS-Filer integration.

Table of Contents

Basic Usage

Installation

Development

For ease, certain scripts have been abbreviated in Makefile, make sure that have installed the dependencies before running the commands.

Note: make commands are only available for Unix-based systems.

To view the commands available, run:

make

Here are certain commands that you might find useful:

  • Making a virtual environment
make v
  • Installing all dependencies including optional dependencies
make i

Note: This project uses optional dependency groups such as types, code_quality, docs, vulnerability, test, and misc. To install stubs or types for the dependencies, you must use the following command:

poetry add types-foo --group types

Replace types-foo with the name of the package for the types. All runtime dependencies should be added to the default group. For example, to install requests and its type stubs, run:

poetry add requests
poetry add types-requests --group types

This ensures that the type checker functions correctly.

  • Running tests
make t
  • Running linter, formatter and spell checker
make fl
  • Building the documentation
make d

Note: If you make changes to the code, make sure to generate and push the documentation using above command, else the documentation check CI will fail.

  • Running type checker
make tc
  • Running all pre-commit checks
make pc

Note: This is not the complete list of commands, run make to find out if more have been added.

Contributing

This project is a community effort and lives off your contributions, be it in the form of bug reports, feature requests, discussions, fixes or any other form of contribution!

Please refer to the guidelines available at CONTRIBUTING.md if you are interested in contributing.

Code of Conduct

Please mind the code of conduct described in CODE_OF_CONDUCT.md for all interactions with the community. Please be nice to one another! :)

If you experience any unacceptable behavior by any member of the community, please refer to the contact method specified in CODE_OF_CONDUCT.md to report the incident to the community leaders.

Versioning

The project adopts the semantic versioning scheme for versioning. Currently the software is in a pre-release stage, so changes to the API, including breaking changes, may occur at any time without further notice.

License

This project is distributed under the Apache License 2.0, a copy of which is also available in LICENSE.

Contact

The project is maintained by ELIXIR Cloud & AAI, a Driver Project of the Global Alliance for Genomics and Health (GA4GH), under the umbrella of the ELIXIR Compute Platform.

To get in touch with us, please use one of the following routes:

  • For filing bug reports, feature requests or other code-related issues, please make use of the project's issue tracker.
  • For private/personal issues, more involved communication, or if you would like to join our team as a regular contributor, you can either join our chat board or email the community leaders.

logo-elixir logo-elixir-cloud-aai