aiomegfile 0.0.1

Asyncio implementation of megfile

aiomegfile - Asyncio implementation of megfile

aiomegfile is asyncio implementation of megfile.

Quick Start

This project is not production-ready.

Installation

git clone https://github.com/megvii-research/aiomegfile.git
cd aiomegfile

pip3 install -e .

How to Contribute

• We welcome everyone to contribute code to the aiomegfile project, but the contributed code needs to meet the following conditions as much as possible: You can submit code even if the code doesn't meet conditions. The project members will evaluate and assist you in making code changes

  • Code format: Your code needs to pass code format check. aiomegfile uses ruff as lint tool
  • Static check: Your code needs complete type hint. aiomegfile uses pytype as static check tool. If pytype failed in static check, use # pytype: disable=XXX to disable the error and please tell us why you disable it.
  • Test: Your code needs complete unit test coverage. aiomegfile uses pyfakefs and moto as local file system and s3 virtual environment in unit tests. The newly added code should have a complete unit test to ensure the correctness

• You can help to improve aiomegfile in many ways:

  • Write code.
  • Improve documentation.
  • Report or investigate bugs and issues.
  • If you find any problem or have any improving suggestion, submit a new issuse as well. We will reply as soon as possible and evaluate whether to adopt.
  • Review pull requests.
  • Star aiomegfile repo.
  • Recommend aiomegfile to your friends.
  • Any other form of contribution is welcomed.