Metadata-Version: 2.1
Name: kfm
Version: 0.0.1
Summary: A better way to manage Keyence-generated microscopy data
Home-page: https://github.com/GallowayLabMIT/keyence_file_management
Author: Nathan B. Wang
Author-email: nbwang22@gmail.com
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/GallowayLabMIT/keyence_file_management/issues
Platform: UNKNOWN
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

# keyence_file_management
[![PyPI version fury.io](https://badge.fury.io/py/kfm.svg)](https://pypi.python.org/pypi/ansicolortags/)
[![PyPI license](https://img.shields.io/pypi/l/kfm.svg)](https://pypi.python.org/pypi/kfm/)
[![PyPI pyversions](https://img.shields.io/pypi/pyversions/kfm.svg)](https://pypi.python.org/pypi/kfm/)

[![PyPI download total](https://img.shields.io/pypi/dt/kfm.svg)](https://pypi.python.org/pypi/kfm/)
![Maintaner](https://img.shields.io/badge/maintainer-nbwang22-blue)

 A better way to manage Keyence files.
 
## Install
This package is on PyPI, so just:
```
pip install kfm
```

## Usage
???

## Developer install
If you'd like to hack locally on `kfm`, after cloning this repository:
```
$ git clone https://github.com/GallowayLabMIT/kfm.git
$ cd git
```
you can create a local virtual environment, and install `kfm` in "development mode"
```
$ python -m venv env
$ .\env\Scripts\activate    (on Windows)
$ source env/bin/activate   (on Mac/Linux)
$ pip install -e .
```
After this 'local install', you can use `kfm` freely, and it will update in real time as you work.

## License
This is licensed by the [MIT license](./LICENSE). Use freely!


