Metadata-Version: 2.1
Name: mft_cli
Version: 0.0.9
Summary: For generating WSO2 MFT projects.
Home-page: https://bitbucket.org/dearx-dev/python-mft-cli
Author: James Lahner
Author-email: jlahner@dearx.co.za
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE

<a name="readme-top"></a>
<br />
<div align="center">
  <a>
    <img src="misc/img/FileTransfer-1024x536.jpg" alt="Logo" width="304" height="200">
  </a>

  <h3 align="center">MFT (Managed File Transfer) CLI Tool</h3>

  <p align="center">
    A powerful tool to jumpstart your WSO2 MFT projects!
    <br />
    <br />
    <br />

  </p>
</div>

<!-- TABLE OF CONTENTS -->
<details>
  <summary>Table of Contents</summary>
  <ol>
    <li>
      <a href="#about-the-project">About The Project</a>
    </li>
    <li>
      <a href="#getting-started">Getting Started</a>
      <ul>
        <li><a href="#prerequisites">Prerequisites</a></li>
        <li><a href="#installation">Installation</a></li>
      </ul>
    </li>
    <li><a href="#usage">Usage</a></li>
    <li><a href="#roadmap">Roadmap</a></li>
    <li><a href="#contributing">Contributing</a></li>
    <li><a href="#license">License</a></li>
    <li><a href="#contact">Contact</a></li>
    <li><a href="#acknowledgments">Acknowledgments</a></li>
  </ol>
</details>
<br />

## About The Project ##

This Python CLI tool helps you bootstrap WSO2 ESB MFT (Managed File Transfer) projects easily. With this tool, you can create projects either by using the CLI interface or by passing a configuration file to the application.

Using the CLI interface, you can create WSO2 ESB MFT projects interactively by following the prompts. Alternatively, you can create a configuration file that defines your project's details, and then pass this file to the CLI tool to create the project automatically.

This project was developed with simplicity and ease-of-use in mind, with the aim of making it easier for developers to create and manage WSO2 ESB MFT projects.

<!-- GETTING STARTED -->
## Getting Started

### Prerequisites

Before you can use this CLI tool, you need to have Python 3.10 or above installed on your machine. You can check your Python version by running the following command in your terminal:
```sh
   python3 --version
   ```

If you don't have Python 3.10 or above installed, you can download and install the latest version from the official Python website: https://www.python.org/downloads/

After installing Python,

This is an example of how to list things you need to use the software and how to install them.
* npm
  ```sh
  npm install npm@latest -g
  ```

### Installation

_Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services._

1. Get a free API Key at [https://example.com](https://example.com)
2. Clone the repo
   ```sh
   git clone https://github.com/your_username_/Project-Name.git
   ```
3. Install NPM packages
   ```sh
   npm install
   ```
4. Enter your API in `config.js`
   ```js
   const API_KEY = 'ENTER YOUR API';
   ```

<p align="right">(<a href="#readme-top">back to top</a>)</p>



<!-- USAGE EXAMPLES -->
## Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

_For more examples, please refer to the [Documentation](https://example.com)_

<p align="right">(<a href="#readme-top">back to top</a>)</p>








### What is this repository for? ###

* Quick summary
* Version
* [Learn Markdown](https://bitbucket.org/tutorials/markdowndemo)

### How do I get set up? ###


* Summary of set up
* Configuration
* Dependencies
* Database configuration
* How to run tests
* Deployment instructions

### Contribution guidelines ###

* Writing tests
* Code review
* Other guidelines

### Who do I talk to? ###

* Repo owner or admin
* Other community or team contact
