Hey, Look at me! 👇
Please delete this part after you read it.
If you are first create this repository, please read DELETE_ME.md to get started.
mindfold
Mindfold
Quick start
Conda package manager is recommended. Create a conda environment.
conda create -n mindfold python==3.10
Activate conda environment and install poetry
conda activate mindfold
pip install poetry
Then you can run the client using the following command:
mindfold --help
or with Poetry:
poetry run mindfold --help
Makefile usage
Makefile contains a lot of functions for faster development.
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
Codestyle and type checks
Automatic formatting uses ruff.
make format
Codestyle checks only, without rewriting files:
make check-codestyle
Note:
check-codestyleusesruffanddarglintlibrary
Code security
If this command is not selected during installation, it cannnot be used.
make check-safety
This command launches Poetry integrity checks as well as identifies security issues with Safety and Bandit.
make check-safety
Tests with coverage badges
Run pytest
make test
All linters
Of course there is a command to run all linters in one:
make lint
the same as:
make check-codestyle && make test && make check-safety
Docker
make docker-build
which is equivalent to:
make docker-build VERSION=latest
Remove docker image with
make docker-remove
More information about docker.
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
🛡 License
This project is licensed under the terms of the Apache Software License 2.0 license. See LICENSE for more details.
📃 Citation
@misc{mindfold,
author = {cogit-lab},
title = {Mindfold},
year = {2025},
publisher = {GitHub},
journal = {GitHub repository},
howpublished = {\url{https://github.com/Undertone0809/mindfold}}
}
Credits 
This project was generated with P3G
1 maintainer
Metadata
1 maintainer
Release files for mindfold 0.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| mindfold-0.0.1.tar.gz | 8.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mindfold-0.0.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 16.9 kB
Release files / mindfold-0.0.1.tar.gz
| Download URL | mindfold-0.0.1.tar.gz |
|---|---|
| Size | 8.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
db20f00f5dac08ffea3bf577d989c2ecfbaea74f44f61487203411f019515c8e
|
|
BLAKE2b-256 checksum How to use checksums |
3493a1042651cadab0f7dafd3703bc56d3f8721cee85bdb92ffac57d9cdaab9c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.1.1 CPython/3.11.11 Windows/10
|
Release files / mindfold-0.0.1-py3-none-any.whl
| Download URL | mindfold-0.0.1-py3-none-any.whl |
|---|---|
| Size | 8.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
eeb22584a3816e75edc10b573177e8e85f3192a83d2fd5680b234bc4e5cd935f
|
|
BLAKE2b-256 checksum How to use checksums |
6cbe807f1ad3bc351a51ca9ce80fafb25ab6075edd512e7b3966187a3a85f553
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.1.1 CPython/3.11.11 Windows/10
|
