Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kra-mo/hyperplane

Non-hierarchical file manager
https://github.com/kra-mo/hyperplane

file-manager gnome gtk gtk4 libadwaita python tagging tags

Last synced: 5 days ago
JSON representation

Non-hierarchical file manager

Awesome Lists containing this project

README 

        
> [!NOTE]

> # State of the Project

> This app is currently not actively maintained as I am focused on other projects. I do plan on either picking it up or exploring similar concepts in the future, so I will not archive the repository but I will probably not fix any active issues or accept pull requests for the time being.





  



  # Hyperplane



  A non-hierarchical file manager



  




> [!WARNING]

> This project is currently in **BETA**. You can try it out at your own risk, but be aware that things might break, it might have annoyances, **DATA LOSS** may occur and it may kill your cat.



For now, I recommend only trying it if you have a recent backup of your files.



# The project



The problem is that current methods for tagging files are OS-, file system- or application-specific and not portable.



The app was primarily built as a proof of concept for a non-hierarchical file manager whose storage can still be conveniently browsed via conventional file managers.



It is also a playground for design ideas like file extension badges or a symbolic grid view.



## The concept



Hyperplane stores its 'tags' (called categories) on disk as regular directories.



File A tagged 'Pictures', 'Art' and 'Animals' would be stored at `/Pictures/Art/Animals/` on disk.



File B tagged 'Videos' and 'Art' would be stored at `/Videos/Art/`.



When filtering for files tagged 'Art' however, both of these would show up.



The app keeps track of the list of categories in a `.hyperplane` file at the root of the Hyperplane directory. (Which is `$HOME` by default, but can be changed with the `$HYPHOME` environment variable.)



## The name



https://en.wikipedia.org/wiki/Hyperplane



It is subject to change.



# Testing



The project is currently in beta. Most features work, but user experience still needs refinement.



If you want to test without risking data loss, please set the `$HYPHOME` environment variable to point to somewhere inside `~/.var/app/page.kramo.Hyperplane.Devel/` and remove the app's `--filesystem=host` access.



You can download the latest beta from the [Releases page](https://github.com/kra-mo/hyperplane/releases) or the latest in-development version from [here](https://nightly.link/kra-mo/hyperplane/workflows/ci/main/page.kramo.Hyperplane.Devel-x86_64.zip).



You will need the [GNOME Nightly](https://nightly.gnome.org/) runtime installed to be able to test the app.



Please report any and all issues you find!



UX suggestions and missing feature reports are also welcome, even if it seems obvious.



# Contributing



If you want to help with code or design, please reach out or file an issue before making a pull request. That being said, I appreciate any help!



## Code



### Building



```sh

git clone https://github.com/kra-mo/hyperplane.git

cd hyperplane

meson setup build

ninja -C build install

```



### Code style



All code is auto-formatted with [Black](https://github.com/psf/black) and linted with [Pylint](https://github.com/pylint-dev/pylint). Imports are sorted by [isort](https://github.com/pycqa/isort).



VSCode extensions are available for all of these and you can set them up with the following `settings.json` configuration:



```json

"python.formatting.provider": "none",

"[python]": {

    "editor.defaultFormatter": "ms-python.black-formatter",

    "editor.formatOnSave": true,

    "editor.codeActionsOnSave": {

        "source.organizeImports": true

    },

},

"isort.args":["--profile", "black"],

```



For other code editors, you can install them via `pip` and invoke them from the command line.



## Translations



Strings are not final yet, I will set up translations closer to an initial release.



# Code of Conduct



The project follows the [GNOME Code of Conduct](https://conduct.gnome.org/).



See [CODE_OF_CONDUCT.md](https://github.com/kra-mo/hyperplane/blob/main/CODE_OF_CONDUCT.md).