Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/devinci-it/encode-py
https://github.com/devinci-it/encode-py
Last synced: 22 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/devinci-it/encode-py
- Owner: devinci-it
- License: mit
- Created: 2024-01-31T23:41:02.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-01-31T23:51:18.000Z (9 months ago)
- Last Synced: 2024-02-01T00:36:27.601Z (9 months ago)
- Language: Python
- Size: 0 Bytes
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
`encode` is a Python package that provides a command-line interface for encoding and decoding strings using various methods such as Base64, URL encoding, and HTML encoding.
## Getting Started
### Prerequisites
Make sure you have Python and `pip` installed on your system.
### Clone the Repository
```bash
git clone https://github.com/devinci-it/encoder-py.git
cd encoder-py
```
### Install Dependencies
```bash
# Optionally, create and activate a virtual environment
python -m venv venv
source venv/bin/activate # On Linux or macOS
# or
.\venv\Scripts\activate # On Windows
# Install dependencies
pip install -r requirements.txt
```
## Usage
### Run the Script
```bash
python encoder/cli.py --interactive
```
### Making It System-Wide
To make the `encoder` script accessible system-wide, create a script in a directory in your system's `PATH`. For example, on Linux:
```bash
echo "python /path/to/encoder-py/encoder/cli.py \"\$@\"" | sudo tee /usr/local/bin/encoder
sudo chmod +x /usr/local/bin/encoder
```
Replace `/path/to/encoder-py/` with the actual path to your `encoder-py` directory.
Now, you can run the `encoder` command system-wide:
```bash
$ encoder --interactive
▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄
█░▄▄█░▄▄▀█▀▄▀█▀▄▄▀█░▄▀█░▄▄
█░▄▄█░██░█░█▀█░██░█░█░█░▄▄
█▄▄▄█▄██▄██▄███▄▄██▄▄██▄▄▄
▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
Author: devinci-it
(c) 2024
MIT LICENSE
Usage: python cli.py [OPTIONS]
Options:
-e, --encode Encode input string
-d, --decode Decode input string
-c, --continuous Continuous mode for encoding/decoding
-t, --type TEXT Select encoding type (default: base64)
-i, --interactive Interactive mode for encoding/decoding
-h, --help Show this message and exit
```
## Contributing
If you'd like to contribute, please fork the repository and create a pull request.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.