Research Template Reference

https://github.com/ezhang7423/research_project

Primary Development Features/Dependencies:

• Poetry

• Typer

• eztils

• Dockerfile

• CI/CD for building and publishing

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:

make install
make pre-commit-install

1. Run the codestyle:

make codestyle

Makefile usage

Makefile contains a lot of functions for faster development.

1. Download and remove Poetry

To download and install Poetry run:

make poetry-download

To uninstall

make poetry-remove

2. Install all dependencies and pre-commit hooks

Install requirements:

make install

Pre-commit hooks coulb be installed after git init via

make pre-commit-install

3. Codestyle

Automatic formatting uses pyupgrade, isort and black.

make codestyle

# or use synonym
make formatting

Codestyle checks only, without rewriting files:

make check-codestyle

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

Update all dev libraries to the latest version using one comand

make update-dev-deps

5. Type checks

Run mypy static type checker

make mypy

6. Tests with coverage badges

Run pytest

make test

7. All linters

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

make lint

the same as:

make test && make check-codestyle && make mypy && make check-safety

8. Docker

make docker-build

which is equivalent to:

make docker-build VERSION=latest

Remove docker image with

make docker-remove

More information about docker.

9. Cleanup

Delete pycache files

make pycache-remove

Remove package build

make build-remove

Delete .DS_STORE files

make dsstore-remove

Remove .mypycache

make mypycache-remove

Or to remove all above run:

make cleanup