Metadata-Version: 2.3
Name: misfits
Version: 0.0.7
Summary: A FITS table viewer for the terminal.
Project-URL: Homepage, https://github.com/peppedilillo/misfits
Author-email: Giuseppe Dilillo <peppedilillo@gmail.com>
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.11
Requires-Dist: astropy>=6.1
Requires-Dist: click>=8.1
Requires-Dist: pandas>=2.2
Requires-Dist: terminaltexteffects>=0.11
Requires-Dist: textual>=0.77
Provides-Extra: dev
Requires-Dist: black>=24.8; extra == 'dev'
Requires-Dist: ipython>=8.27; extra == 'dev'
Requires-Dist: isort>=5.13; extra == 'dev'
Requires-Dist: mypy>=1.11; extra == 'dev'
Requires-Dist: textual-dev>=1.5; extra == 'dev'
Description-Content-Type: text/markdown


![misfits's interface](https://github.com/peppedilillo/misfits/blob/main/assets/misfits.gif?raw=true)

# misfits

Misfits is a FITs table viewer for the terminal, written in python.
I want it to be snappy as hell and fully usable without touching the mouse.
It currently has some limitations (e.g. won't display array or VLA columns), but will work on them eventually.
It leverages astropy and pandas, and is built using [textual](https://textual.textualize.io/).
Works on Linux, MacOS and Windows. Performances on Windows are worse.
Renders best on modern terminals: windows new terminal, macOS iTerm2, your typical linux distro is likely fine as it is.

### Installation

`pip install misfits`

Make sure to be installing into a fresh python 3.12 environment!

#### Installing with uv

`uv tool install misfits`

This is the **best method**. But you should install uv first, see their [docs](https://docs.astral.sh/uv/getting-started/installation/).
The other methods will require you to activate the misfits environment to use it.
This won't, and you will be able to call misfits from terminal with one line: `misfits .`.

If you are unsure about `uv`: please don't, you should probably it. 
It is a great package manager from the [Astral](https://astral.sh/) people.

#### Installing with anaconda

`conda env create -f conda-env.yml`

Will create a new environment and install `misfits` in it.

### Usage

From the terminal, type `misfits path_to_file.fits` or `misfits .`. 
The latter will open a prompt to choose a fits file from your current directory.
