Metadata-Version: 2.1
Name: fmc
Version: 0.2.0
Summary: fmc is a simple cli application for one's own convenience.
Home-page: UNKNOWN
Author: Ming Feng
Author-email: fengming@mail.com
License: MIT
Keywords: fmc,shortcut,alias
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Intended Audience :: Developers
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: plumbum (==1.6.9)

## Introduction
fmc (For-My-Convenience) is a simple cli application for one's own convenience.

## Usage

### Installation

```sh
# Install from pip
pip install fmc

# Install from source
pip install .
```

### Commands

#### Basic 

```sh
# Check fmc version
fmc --version

# Check help info
fmc -h

# Check environment info
fmc info
```

#### Go - convenient 'cd' with alias 

```sh
# setup path alias
fmc go work -s path_to_my_workspace
# go to workspace
fmc go work
```

#### Secure - file encryption

- You'll have to install gpg first
- Tehn create a private key
- For first run, the gpg_user_id is needed

```sh
# setup alias for a file which needs to be encrypted
fmc secure secret -s path_to_the_file.zip
# encryption or decryption
fmc secure secret
```

### Config File
Configuration file is located at `~/fmc.conf`.

## Developement

```sh
# Run by python3
python3 ./fmc.py *args*

# Smoke test
./smoke.sh
```

