Metadata-Version: 2.1
Name: SoftCOM
Version: 1.2.1
Summary: SoftCOM is a free software for accessing the serial port.
Home-page: https://github.com/mathieeo/SoftCOM
Author: Matthew Mesropian
Author-email: matt@integratedsw.tech
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Environment :: Console
Classifier: Topic :: Terminals :: Serial
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: prompt_toolkit
Requires-Dist: Pygments~=2.11.2
Requires-Dist: pyperclip
Requires-Dist: pyserial

<!-- TABLE OF CONTENTS -->
<details>
  <summary>Table of Contents</summary>
  <ol>
    <li>
      <a href="#about-the-project">About The Project</a>
      <ul>
        <li><a href="#built-with">Built With</a></li>
      </ul>
    </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>

[![Python Version](https://img.shields.io/badge/python-3.10.x-brightgreen.svg)](https://python.org)
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
[![issues](https://img.shields.io/github/issues/mathieeo/softcom)](https://github.com/mathieeo/softcom/issues)
[![issues](https://img.shields.io/github/languages/count/mathieeo/softcom)](https://github.com/mathieeo/softcom)
[![issues](https://img.shields.io/github/languages/code-size/mathieeo/softcom)](https://github.com/mathieeo/softcom)
[![issues](https://img.shields.io/github/followers/mathieeo?style=social)](https://github.com/mathieeo/softcom)


# [<img alt="" width="30x" src="https://static.wixstatic.com/media/b3d4ff_6d86c4d4b77245d8894a815b759ed7fd~mv2.png/v1/fill/w_132,h_119,al_c,usm_0.66_1.00_0.01,enc_auto/logo.png" />](https://integratedsw.tech) SoftCOM by [Integrated Software Technologies Inc.](https://integratedsw.tech)

[<img alt="alt_text" width="700x" src="https://static.wixstatic.com/media/b3d4ff_c4baf39b3cb1454b8fae56fc671e39b1~mv2.gif" />](https://video.wixstatic.com/video/b3d4ff_18938d64e26b4d1fa02a9c6c7e03501d/480p/mp4/file.mp4)


<!-- ABOUT THE PROJECT -->
## About The Project

SoftCOM is a free software for accessing the serial port.
Please reed the license agreement for more details.

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

# Supported Operating-Systems
* **Microsoft Windows v10 64-bit**
* **MacOS Monterey v12.2.1**
* **Ubuntu 20.04**
* **RedHat 8.5**

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

### Built With

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

* [Python](https://www.python.org)
* [prompt_toolkit](https://python-prompt-toolkit.readthedocs.io/en/master/)
* [pyperclip](https://pypi.org/project/pyperclip/)
* [argparse](https://docs.python.org/3/library/argparse.html)
* [pre-commit](https://pre-commit.com)
* [pylintpylint](https://pylint.org)
* [serial](https://pyserial.readthedocs.io/en/latest/)
<p align="right">(<a href="#top">back to top</a>)</p>

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

This is an example of how you may give instructions on setting up your project locally.
To get a local copy up and running follow these simple example steps.


### 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. Clone the repo
   ```sh
   git clone https://github.com/mathieeo/softcom.git
   ```
2. Install virtual environment
   ```sh
   pip install virtualenv
   ```
3. Run virtual
   ```sh
   virtualenv venv && source venv/bin/activate
   ```
4. Install requirements
   ```sh
   pip install -r requirements.txt
   ```

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



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

From the terminal (Console) cd to the project directory from there execute the following command:
   ```sh
   python3.10 softcom.py
   ```

**Application arguments:**

|  Argument   | pram |       Description        |
|:-----------:|:----:|:------------------------:|
| --simulator |  -s  |  Run in simulator mode   |
|  --config   |  -c  | re-configure serial port |

**in-app Options:**

|       Option       |    Key    |                       Description                        |
|:------------------:|:---------:|:--------------------------------------------------------:|
|        Quit        | Control+Q |                   Quit the application                   |
|     Clear Log      | Control+X |                  Clears the output log                   |
|     Pauses Log     | Control+P |                 Pause the output logging                 |
|   Export to File   | Control+S |             Export the output log to a file              |
| Start/Stop Capture | Control+W |   Start the capture mode. Save portion of output log.    |
| Copy to Clipboard  | Control+C |           Copy the entire log to the clipboard           |
| Highlight Pattern  | Control+S |          Search and find for a specific string           |
|   Find and Stop    | Control+G | Search and find for a specific string and stop if found. |
|    Show License    | Control+L |          Show the license for this application.          |
|        Help        | Control+H |                Used to show help string.                 |
|       Debug        | Shift+Tab |                    Used for debuting.                    |

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



<!-- ROADMAP -->
## Roadmap

- [x] Add Changelog
- [x] Add back to top links
- [ ] Add Additional Templates w/ Examples
- [ ] Add "components" document to easily copy & paste sections of the readme


See the [open issues](https://github.com/mathieeo/softcom/issues) for a full list of proposed features (and known issues).

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



<!-- CONTRIBUTING -->
## Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!

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

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



<!-- LICENSE -->
## License

Distributed under the GNU GPLv3 License. See `LICENSE` for more information.

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


<!-- CONTACT -->
## Contact

Matthew - [eMail](mailto:matt@integratedsw.tech?subject=SoftCOM)

Project Link: [SoftCOM](https://github.com/mathieeo/softcom)

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

[<img alt="alt_text" width="300x" src="https://static.wixstatic.com/media/b3d4ff_fd5635e886fa4ff1ab24e822f2fc4bbc~mv2.gif" />](https://integratedsw.tech)
