<!-- Author: Daniel Benjamin Perez Morales -->
<!-- GitHub: https://github.com/DanielPerezMoralesDev13 -->
<!-- Email: danielperezdev@proton.me -->
<!-- PYTHONPATH=src python3 src/cli/main.py --help -->
# ***pycrypy***
> *`pycrypy` is a command-line tool written in Python for easily configuring Alacritty options from the terminal. It allows you to adjust themes, fonts, font size, opacity, padding, cursor shape, and more with simple commands.*
## ***Features***
- [x] **Theme Change:** *Modify the Alacritty theme using a file path or a theme name.*
- [x] **Font Configuration:** *Change the font and font size in Alacritty.*
- [x] **Opacity Adjustment:** *Modify the terminal's opacity.*
- [x] **Padding Configuration:** *Adjust the terminal's padding.*
- [x] **Cursor Shape:** *Change the cursor shape and blinking.*
## ***Installation***
### ***Installation via PyPI***
**You can easily install `pycrypy` using `pip`:**
```bash
pip install pycrypy
```
### ***Installation from Source Code***
1. **Clone the Repository:**
```bash
git clone https://github.com/DanielPerezMoralesDev13/pycrypy.git --depth=1
```
2. **Navigate to the Project Directory:**
```bash
cd pycrypy
```
3. **Install Dependencies:**
```bash
pip install -r requirements.txt
```
4. **Install the Package:**
```bash
pip install .
```
## ***Usage***
> *To use `pycrypy`, simply run the `pycrypy` command followed by the desired options. Here is a description of the available options:*
### ***Options***
```bash
pycrypy [-h] [-t [THEME ...]] [-P [THEMEPATH]] [-f [FONT ...]] [-F [FONTSIZE]] [-s [STYLE ...]]
[-o OPACITY] [-p X Y] [-S [CURSORSHAPE]] [-B [CURSORBLINKING]] [-T [CURSORTHICKNESS]]
[-R] [-D] [-L] [-v] [-V]
```
### ***-h, --help***
**Displays this help message and exits.**
```bash
usage: pycrypy [-h] [-t [THEME ...]] [-P [THEMEPATH]] [-f [FONT ...]] [-F [FONTSIZE]] [-s [STYLE ...]]
[-o OPACITY] [-p X Y] [-S [CURSORSHAPE]] [-B [CURSORBLINKING]] [-T [CURSORTHICKNESS]] [-R]
[-D] [-L] [-v] [-V]
pycrypy is a command-line tool designed to easily configure Alacritty options
from the terminal using Python.
options:
-h, --help show this help message and exit
-t [THEME ...], --theme [THEME ...]
Changes the theme used by Alacritty
-P [THEMEPATH], --theme-path [THEMEPATH]
Absolute or relative path of the theme to be applied in the Alacritty terminal
-f [FONT ...], --font [FONT ...]
Changes the font used by Alacritty
-F [FONTSIZE], --font-size [FONTSIZE]
Changes the font size
-s [STYLE ...], --style [STYLE ...]
Changes the font style: Normal | Bold | Italic | Underline
-o OPACITY, --opacity OPACITY
Changes the opacity of the Alacritty terminal
-p X Y, --padding X Y
Changes the padding of the Alacritty terminal
-S [CURSORSHAPE], --cursor-shape [CURSORSHAPE]
shape is an option that defines the cursor shape and can take one of these values:
Block | Underline | Beam
-B [CURSORBLINKING], --cursor-blinking [CURSORBLINKING]
This option defines if the cursor blinks and can have one of these values: Never | Off
| On | Always
-T [CURSORTHICKNESS], --cursor-thickness [CURSORTHICKNESS]
This option defines the cursor thickness
-R, --theme-recommendations
Lists recommended themes for Alacritty
-D, --theme-dark Lists dark themes for Alacritty
-L, --theme-light Lists light themes for Alacritty
-v, --verbose Enable verbose mode
-V, --version Displays the version of the program and author details
Enjoy configuring your Alacritty with pycrypy!
```
### ***-t [THEME ...], --theme [THEME ...]***
- *Changes the theme used by Alacritty. You can specify one or more themes.*
**Example:**
```bash
pycrypy -t tokyo night
```
*This command changes the Alacritty theme to tokyo night.*
### ***-P [THEMEPATH], --theme-path [THEMEPATH]***
- *Absolute or relative path of the theme to be applied in the Alacritty terminal.*
**Example:**
```bash
pycrypy -P /home/user/.config/alacritty/themes/mytheme.toml
```
*This command applies the theme from the specified path.*
### ***-f [FONT ...], --font [FONT ...]***
- *Changes the font used by Alacritty. You can specify one or more fonts.*
**Example:**
```bash
pycrypy -f Cascadia Code NF
```
*This command changes the Alacritty font to Cascadia Code NF.*
### ***-F [FONTSIZE], --font-size [FONTSIZE]***
- *Changes the font size.*
**Example:**
```bash
pycrypy -F 14
```
*This command sets the font size to 14.*
### ***-s [STYLE ...], --style [STYLE ...]***
- *Changes the font style: Normal | Bold | Italic | Underline. You can specify one or more styles.*
**Example:**
```bash
pycrypy -s Bold Italic
```
*This command applies Bold Italic styles to the font in Alacritty.*
### ***-o OPACITY, --opacity OPACITY***
- *Changes the opacity of the Alacritty terminal.*
**Example:**
```bash
pycrypy -o 0.8
```
*This command sets the terminal opacity to 80%.*
### ***-p X Y, --padding X Y***
- *Changes the padding of the Alacritty terminal.*
**Example:**
```bash
pycrypy -p 10 15
```
*This command sets the padding to 10 pixels vertical and 15 pixels horizontal.*
### ***-S [CURSORSHAPE], --cursor-shape [CURSORSHAPE]***
- *Defines the cursor shape. It can take one of these values: Block | Underline | Beam.*
**Example:**
```bash
pycrypy -S Beam
```
*This command sets the cursor shape to Beam.*
### ***-B [CURSORBLINKING], --cursor-blinking [CURSORBLINKING]***
- *Defines whether the cursor blinks. It can have one of these values: Never | Off | On | Always.*
**Example:**
```bash
pycrypy -B Always
```
*This command sets the cursor blinking to Always.*
### ***-T [CURSORTHICKNESS], --cursor-thickness [CURSORTHICKNESS]***
- *Defines the thickness of the cursor.*
**Example:**
```bash
pycrypy -T 2
```
*This command sets the cursor thickness to 2 pixels.*
### ***-R, --theme-recommendations***
- *Lists recommended themes for Alacritty.*
**Example:**
```bash
pycrypy -R
```
*This command displays a list of recommended themes for Alacritty.*
### ***-D, --theme-dark***
- *Lists dark themes for Alacritty.*
**Example:**
```bash
pycrypy -D
```
*This command displays a list of dark themes for Alacritty.*
### ***-L, --theme-light***
- *Lists light themes for Alacritty.*
**Example:**
```bash
pycrypy -L
```
*This command displays a list of light themes for Alacritty.*
### ***-v, --verbose***
- *Enables verbose mode.*
**Example:**
```bash
pycrypy -v
```
*This command runs `pycrypy` in verbose mode, showing additional information.*
### ***-V, --version***
- *Displays the program version and author information.*
**Example:**
```bash
pycrypy -V
```
*This command shows the current version of the program and author information.*
### ***Creating an Executable with PyInstaller***
> *To convert the `src/cli/main.py` script into a standalone executable, use PyInstaller with the following options:*
**Here is the equivalent `pyinstaller` command for the configuration you provided:**
```bash
pyinstaller --onefile \
--noconfirm \
--clean \
--noconsole \
--name pycrypy \
--add-data "./src/TemasClaros:TemasClaros" \
--add-data "./src/TemasOscuros:TemasOscuros" \
--add-data "./src/TemasRecomendados:TemasRecomendados" \
--add-data "./src/cli:cli" \
--add-data "./src/config:config" \
g --add-data "./src/lib:lib" \
./src/cli/main.py
```
### ***Command Breakdown***
- **`--onefile`:** *Creates a single executable file.*
- **`--noconfirm`:** *Does not prompt for confirmation before overwriting files.*
- **`--clean`:** *Cleans up temporary build files.*
- **`--noconsole`:** *Does not open a console window when running the executable (for GUI applications).*
- **`--name pycrypy`:** *Defines the name of the executable file.*
- **`--add-data "src:dest"`:** *Specifies additional data files and their destinations in the executable. The syntax is `"source_path:destination_path".*
- **`src/cli/main.py`:** *The main script file.*
### ***Running the Command***
*Run the command in the terminal from the directory where your `src/cli/main.py` file is located. PyInstaller will package your application, including the specified directories and files.*
*If you need to adjust data file paths, ensure they are correct relative to the directory from which you are running the command.*
### ***Troubleshooting***
- **`objcopy` Error:** *If you encounter errors related to `objcopy`, ensure that all input files are correct and there are no file permission issues. Verify that the file specified in `--name` is not in use and that the working directory is clean.*
- **Missing Dependencies:** *If the executable fails due to missing dependencies, ensure that all required libraries are installed and accessible from the Python environment.*
### ***Contributing***
**If you want to contribute to `pycrypy`, please follow these steps:**
1. **Fork the Repository.**
2. **Create a New Branch** *for your feature or bug fix.*
3. **Make Changes** *and commit your changes.*
4. **Submit a Pull Request** *with a clear description of the changes made.*
### ***License***
> *This repository is published under the MIT License. Feel free to use, modify, and distribute the content according to the terms of this license.*
### ***Author***
- **Author:** *Daniel Benjamin Perez Morales*
- **GitHub:** *[DanielPerezMoralesDev13](https://github.com/DanielPerezMoralesDev13 "https://github.com/DanielPerezMoralesDev13")*
- **Email:** *`danielperezdev@proton.me`*
Raw data
{
"_id": null,
"home_page": "https://github.com/DanielPerezMoralesDev13/pycrypy.git",
"name": "pycrypy",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "alacritty",
"author": "Daniel Benjamin Perez Morales",
"author_email": "danielperezdev@proton.me",
"download_url": "https://files.pythonhosted.org/packages/9c/33/1e5faefabe93a3f322552f0fa793ede8f4e69627362dcc2155551aec0177/pycrypy-0.0.0a1.tar.gz",
"platform": null,
"description": "<!-- Author: Daniel Benjamin Perez Morales -->\n<!-- GitHub: https://github.com/DanielPerezMoralesDev13 -->\n<!-- Email: danielperezdev@proton.me -->\n\n<!-- PYTHONPATH=src python3 src/cli/main.py --help -->\n\n# ***pycrypy***\n\n> *`pycrypy` is a command-line tool written in Python for easily configuring Alacritty options from the terminal. It allows you to adjust themes, fonts, font size, opacity, padding, cursor shape, and more with simple commands.*\n\n## ***Features***\n\n- [x] **Theme Change:** *Modify the Alacritty theme using a file path or a theme name.*\n- [x] **Font Configuration:** *Change the font and font size in Alacritty.*\n- [x] **Opacity Adjustment:** *Modify the terminal's opacity.*\n- [x] **Padding Configuration:** *Adjust the terminal's padding.*\n- [x] **Cursor Shape:** *Change the cursor shape and blinking.*\n\n## ***Installation***\n\n### ***Installation via PyPI***\n\n**You can easily install `pycrypy` using `pip`:**\n\n```bash\npip install pycrypy\n```\n\n### ***Installation from Source Code***\n\n1. **Clone the Repository:**\n\n ```bash\n git clone https://github.com/DanielPerezMoralesDev13/pycrypy.git --depth=1\n ```\n\n2. **Navigate to the Project Directory:**\n\n ```bash\n cd pycrypy\n ```\n\n3. **Install Dependencies:**\n\n ```bash\n pip install -r requirements.txt\n ```\n\n4. **Install the Package:**\n\n ```bash\n pip install .\n ```\n\n## ***Usage***\n\n> *To use `pycrypy`, simply run the `pycrypy` command followed by the desired options. Here is a description of the available options:*\n\n### ***Options***\n\n```bash\npycrypy [-h] [-t [THEME ...]] [-P [THEMEPATH]] [-f [FONT ...]] [-F [FONTSIZE]] [-s [STYLE ...]]\n [-o OPACITY] [-p X Y] [-S [CURSORSHAPE]] [-B [CURSORBLINKING]] [-T [CURSORTHICKNESS]]\n [-R] [-D] [-L] [-v] [-V]\n```\n\n### ***-h, --help***\n\n**Displays this help message and exits.**\n\n```bash\nusage: pycrypy [-h] [-t [THEME ...]] [-P [THEMEPATH]] [-f [FONT ...]] [-F [FONTSIZE]] [-s [STYLE ...]]\n [-o OPACITY] [-p X Y] [-S [CURSORSHAPE]] [-B [CURSORBLINKING]] [-T [CURSORTHICKNESS]] [-R]\n [-D] [-L] [-v] [-V]\n\npycrypy is a command-line tool designed to easily configure Alacritty options\nfrom the terminal using Python.\n\noptions:\n -h, --help show this help message and exit\n -t [THEME ...], --theme [THEME ...]\n Changes the theme used by Alacritty\n -P [THEMEPATH], --theme-path [THEMEPATH]\n Absolute or relative path of the theme to be applied in the Alacritty terminal\n -f [FONT ...], --font [FONT ...]\n Changes the font used by Alacritty\n -F [FONTSIZE], --font-size [FONTSIZE]\n Changes the font size\n -s [STYLE ...], --style [STYLE ...]\n Changes the font style: Normal | Bold | Italic | Underline\n -o OPACITY, --opacity OPACITY\n Changes the opacity of the Alacritty terminal\n -p X Y, --padding X Y\n Changes the padding of the Alacritty terminal\n -S [CURSORSHAPE], --cursor-shape [CURSORSHAPE]\n shape is an option that defines the cursor shape and can take one of these values:\n Block | Underline | Beam\n -B [CURSORBLINKING], --cursor-blinking [CURSORBLINKING]\n This option defines if the cursor blinks and can have one of these values: Never | Off\n | On | Always\n -T [CURSORTHICKNESS], --cursor-thickness [CURSORTHICKNESS]\n This option defines the cursor thickness\n -R, --theme-recommendations\n Lists recommended themes for Alacritty\n -D, --theme-dark Lists dark themes for Alacritty\n -L, --theme-light Lists light themes for Alacritty\n -v, --verbose Enable verbose mode\n -V, --version Displays the version of the program and author details\n\nEnjoy configuring your Alacritty with pycrypy!\n```\n\n### ***-t [THEME ...], --theme [THEME ...]***\n\n- *Changes the theme used by Alacritty. You can specify one or more themes.*\n\n**Example:**\n\n```bash\npycrypy -t tokyo night\n```\n\n*This command changes the Alacritty theme to tokyo night.*\n\n### ***-P [THEMEPATH], --theme-path [THEMEPATH]***\n\n- *Absolute or relative path of the theme to be applied in the Alacritty terminal.*\n\n**Example:**\n\n```bash\npycrypy -P /home/user/.config/alacritty/themes/mytheme.toml\n```\n\n*This command applies the theme from the specified path.*\n\n### ***-f [FONT ...], --font [FONT ...]***\n\n- *Changes the font used by Alacritty. You can specify one or more fonts.*\n\n**Example:**\n\n```bash\npycrypy -f Cascadia Code NF\n```\n\n*This command changes the Alacritty font to Cascadia Code NF.*\n\n### ***-F [FONTSIZE], --font-size [FONTSIZE]***\n\n- *Changes the font size.*\n\n**Example:**\n\n```bash\npycrypy -F 14\n```\n\n*This command sets the font size to 14.*\n\n### ***-s [STYLE ...], --style [STYLE ...]***\n\n- *Changes the font style: Normal | Bold | Italic | Underline. You can specify one or more styles.*\n\n**Example:**\n\n```bash\npycrypy -s Bold Italic\n```\n\n*This command applies Bold Italic styles to the font in Alacritty.*\n\n### ***-o OPACITY, --opacity OPACITY***\n\n- *Changes the opacity of the Alacritty terminal.*\n\n**Example:**\n\n```bash\npycrypy -o 0.8\n```\n\n*This command sets the terminal opacity to 80%.*\n\n### ***-p X Y, --padding X Y***\n\n- *Changes the padding of the Alacritty terminal.*\n\n**Example:**\n\n```bash\npycrypy -p 10 15\n```\n\n*This command sets the padding to 10 pixels vertical and 15 pixels horizontal.*\n\n### ***-S [CURSORSHAPE], --cursor-shape [CURSORSHAPE]***\n\n- *Defines the cursor shape. It can take one of these values: Block | Underline | Beam.*\n\n**Example:**\n\n```bash\npycrypy -S Beam\n```\n\n*This command sets the cursor shape to Beam.*\n\n### ***-B [CURSORBLINKING], --cursor-blinking [CURSORBLINKING]***\n\n- *Defines whether the cursor blinks. It can have one of these values: Never | Off | On | Always.*\n**Example:**\n\n```bash\npycrypy -B Always\n```\n\n*This command sets the cursor blinking to Always.*\n\n### ***-T [CURSORTHICKNESS], --cursor-thickness [CURSORTHICKNESS]***\n\n- *Defines the thickness of the cursor.*\n**Example:**\n\n```bash\npycrypy -T 2\n```\n\n*This command sets the cursor thickness to 2 pixels.*\n\n### ***-R, --theme-recommendations***\n\n- *Lists recommended themes for Alacritty.*\n**Example:**\n\n```bash\npycrypy -R\n```\n\n*This command displays a list of recommended themes for Alacritty.*\n\n### ***-D, --theme-dark***\n\n- *Lists dark themes for Alacritty.*\n**Example:**\n\n```bash\npycrypy -D\n```\n\n*This command displays a list of dark themes for Alacritty.*\n\n### ***-L, --theme-light***\n\n- *Lists light themes for Alacritty.*\n**Example:**\n\n```bash\npycrypy -L\n```\n\n*This command displays a list of light themes for Alacritty.*\n\n### ***-v, --verbose***\n\n- *Enables verbose mode.*\n**Example:**\n\n```bash\npycrypy -v\n```\n\n*This command runs `pycrypy` in verbose mode, showing additional information.*\n\n### ***-V, --version***\n\n- *Displays the program version and author information.*\n**Example:**\n\n```bash\npycrypy -V\n```\n\n*This command shows the current version of the program and author information.*\n\n### ***Creating an Executable with PyInstaller***\n\n> *To convert the `src/cli/main.py` script into a standalone executable, use PyInstaller with the following options:*\n\n**Here is the equivalent `pyinstaller` command for the configuration you provided:**\n\n```bash\npyinstaller --onefile \\\n --noconfirm \\\n --clean \\\n --noconsole \\\n --name pycrypy \\\n --add-data \"./src/TemasClaros:TemasClaros\" \\\n --add-data \"./src/TemasOscuros:TemasOscuros\" \\\n --add-data \"./src/TemasRecomendados:TemasRecomendados\" \\\n --add-data \"./src/cli:cli\" \\\n --add-data \"./src/config:config\" \\\n g --add-data \"./src/lib:lib\" \\\n ./src/cli/main.py\n```\n\n### ***Command Breakdown***\n\n- **`--onefile`:** *Creates a single executable file.*\n- **`--noconfirm`:** *Does not prompt for confirmation before overwriting files.*\n- **`--clean`:** *Cleans up temporary build files.*\n- **`--noconsole`:** *Does not open a console window when running the executable (for GUI applications).*\n- **`--name pycrypy`:** *Defines the name of the executable file.*\n- **`--add-data \"src:dest\"`:** *Specifies additional data files and their destinations in the executable. The syntax is `\"source_path:destination_path\".*\n- **`src/cli/main.py`:** *The main script file.*\n\n### ***Running the Command***\n\n*Run the command in the terminal from the directory where your `src/cli/main.py` file is located. PyInstaller will package your application, including the specified directories and files.*\n\n*If you need to adjust data file paths, ensure they are correct relative to the directory from which you are running the command.*\n\n### ***Troubleshooting***\n\n- **`objcopy` Error:** *If you encounter errors related to `objcopy`, ensure that all input files are correct and there are no file permission issues. Verify that the file specified in `--name` is not in use and that the working directory is clean.*\n\n- **Missing Dependencies:** *If the executable fails due to missing dependencies, ensure that all required libraries are installed and accessible from the Python environment.*\n\n### ***Contributing***\n\n**If you want to contribute to `pycrypy`, please follow these steps:**\n\n1. **Fork the Repository.**\n\n2. **Create a New Branch** *for your feature or bug fix.*\n\n3. **Make Changes** *and commit your changes.*\n\n4. **Submit a Pull Request** *with a clear description of the changes made.*\n\n### ***License***\n\n> *This repository is published under the MIT License. Feel free to use, modify, and distribute the content according to the terms of this license.*\n\n### ***Author***\n\n- **Author:** *Daniel Benjamin Perez Morales*\n\n- **GitHub:** *[DanielPerezMoralesDev13](https://github.com/DanielPerezMoralesDev13 \"https://github.com/DanielPerezMoralesDev13\")*\n\n- **Email:** *`danielperezdev@proton.me`*\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Esta utilidad, desarrollada en Python3, simplifica significativamente el proceso de configuracion de Alacritty, permitiendo ajustar de manera simple la fuente, el tema, el padding, los cursores y los estilos de la fuente.",
"version": "0.0.0a1",
"project_urls": {
"Homepage": "https://github.com/DanielPerezMoralesDev13/pycrypy.git"
},
"split_keywords": [
"alacritty"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fddc781c9e032aeb6d955c503e23dd62f1c1b249abd9710da1eb5a4bb7535789",
"md5": "696ad15ee39d1a75a1693562482412c2",
"sha256": "d535279279bcb1f5ac72764877b48ed38a4d1055f7663cf3ba982795254f2f1a"
},
"downloads": -1,
"filename": "pycrypy-0.0.0a1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "696ad15ee39d1a75a1693562482412c2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 124970,
"upload_time": "2024-08-27T03:52:37",
"upload_time_iso_8601": "2024-08-27T03:52:37.175313Z",
"url": "https://files.pythonhosted.org/packages/fd/dc/781c9e032aeb6d955c503e23dd62f1c1b249abd9710da1eb5a4bb7535789/pycrypy-0.0.0a1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9c331e5faefabe93a3f322552f0fa793ede8f4e69627362dcc2155551aec0177",
"md5": "0ab8e007821b3d4a58ef82cb172faeba",
"sha256": "4d16707a2fc952ee80b7301906df6082b7eba0e3fadc8c237979be69eeb8c9ae"
},
"downloads": -1,
"filename": "pycrypy-0.0.0a1.tar.gz",
"has_sig": false,
"md5_digest": "0ab8e007821b3d4a58ef82cb172faeba",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 5190,
"upload_time": "2024-08-27T03:52:38",
"upload_time_iso_8601": "2024-08-27T03:52:38.673083Z",
"url": "https://files.pythonhosted.org/packages/9c/33/1e5faefabe93a3f322552f0fa793ede8f4e69627362dcc2155551aec0177/pycrypy-0.0.0a1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-27 03:52:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "DanielPerezMoralesDev13",
"github_project": "pycrypy",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "colored",
"specs": [
[
"==",
"2.2.4"
]
]
},
{
"name": "mypy",
"specs": [
[
"==",
"1.10.0"
]
]
},
{
"name": "pyinstaller",
"specs": [
[
"==",
"6.6.0"
]
]
},
{
"name": "prettytable",
"specs": [
[
"==",
"3.10.2"
]
]
},
{
"name": "toml",
"specs": [
[
"==",
"0.10.2"
]
]
}
],
"lcname": "pycrypy"
}
JSON
