File handler utilizing TUS and MinIO with DRS-Filer integration.
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
, andmisc
. To install stubs or types for the dependencies, you must use the following command:poetry add types-foo --group typesReplace
types-foo
with the name of the package for the types. All runtime dependencies should be added to thedefault
group. For example, to installrequests
and its type stubs, run:poetry add requests poetry add types-requests --group typesThis 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.
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.
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.
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.
This project is distributed under the Apache License 2.0, a
copy of which is also available in LICENSE
.
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.