bring structure for chaos
Explore the docs »

Report Bug · Request Feature

Table of Contents

• Table of Contents
• About The Project
  • Powered By
• Getting Started
  • Flathub Installation
  • Local Installation
    • Prerequisites
    • Installation
    • Usage
• Roadmap
• Contributing
• License

About The Project

Black Fennec is able to view and edit semi-structured data such as JSON by interpreting information compositions known to its type system. These interpretations are then visualised. The type system in its nature is a weakly typed dynamic object model that can be extended easily. To support specialised use cases and allow rapid development Black Fennec provides an extension api which allows users to extend the type system with their own custom types and visualisations.

Powered By

• GTK4
• Libadwaita
• Python
• Pytest

Getting Started

Flathub Installation

Black Fennec is available from Flathub. Preferably install it from your distribution's package manager.

Otherwise it is also directly available from Flathub. To install click the button below:

Local Installation

Prerequisites

To run Black-Fennec one needs python 3.10 installed on the computer.

Additionally the following OS-level dependencies are required:

sudo dnf install python3-devel cairo cairo-devel gobject-introspection-devel cairo-gobject-devel

Installation

Clone the repo

git clone https://gitlab.ost.ch/blackfennec/blackfennec.git --recurse-submodules

Install PIP packages

make dependencies

Usage

make run

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the GNU General Public License. See LICENSE for more information.