Edit

Research Template Reference

https://github.com/ezhang7423/research_project

Primary Development Features/Dependencies:

Dive into the specifics of each feature by checking out the complete documentation for each.

Optional Features

Google Drive Remote Filesystem

Option 1 (mounts google drive onto local file system): https://github.com/astrada/google-drive-ocamlfuse

Option 2 (makes gdrive act like a local folder with fsspec api):

https://github.com/fsspec/gdrivefs

🏗️ Development

  1. Install and initialize poetry and install pre-commit hooks:

  1. Run the codestyle:

Makefile usage

Makefile contains a lot of functions for faster development.

1. Download and remove Poetry

To download and install Poetry run:

To uninstall

2. Install all dependencies and pre-commit hooks

Install requirements:

Pre-commit hooks coulb be installed after git init via

3. Codestyle

Automatic formatting uses pyupgrade, isort and black.

Codestyle checks only, without rewriting files:

Note: check-codestyle uses isort, black and darglint library

Update all dev libraries to the latest version using one comand

5. Type checks

Run mypy static type checker

6. Tests with coverage badges

Run pytest

7. All linters

Of course there is a command to rule run all linters in one:

the same as:

8. Docker

which is equivalent to:

Remove docker image with

More information about docker.

9. Cleanup

Delete pycache files

Remove package build

Delete .DS_STORE files

Remove .mypycache

Or to remove all above run:

PreviousQuick StartNextPoetry

Last updated

Was this helpful?