| Name | aukey JSON |
| Version |
0.1.2
JSON |
| download |
| home_page | None |
| Summary | A package for executing programs, files, websites by using shortcuts. |
| upload_time | 2024-08-28 16:35:19 |
| maintainer | None |
| docs_url | None |
| author | Mostafa Mohamed Atef |
| requires_python | None |
| license | MIT license |
| keywords |
aukey
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# aukey
**aukey** is a Python package designed to execute programs, files, and websites using customizable keyboard shortcuts.
## Features
- Custom Shortcuts: Define custom keyboard shortcuts to execute programs, open files, or visit websites.
- Flexible Configuration: Configure shortcuts using a dictionary or JSON file.
- Multiple Action Types: Supports different action types, including executing programs, opening files, and launching URLs.
- Cross-Platform Compatibility: Works on both Windows and Linux systems.
- Installation
- You can install aukey directly from PyPI using pip:
## Installation
You can install aukey directly from PyPI using pip:
```bash
pip install aukey
```
## Usage
Basic Setup
1. Import the package:
```python
import aukey
```
2. Create your shortcuts configuration:
You can define your shortcuts directly in the code or use an external JSON file.
Example configuration:
```python
shortcuts = [
{"name": "Open Notepad", "shortcut": "ctrlaltn", "type": "program", "path": "notepad.exe"},
{"name": "Open Google", "shortcut": "ctrlaltg", "type": "website", "path": "https://www.google.com"},
{"name": "Open a Document", "shortcut": "ctrlaltd", "type": "file", "path": "C:/path/to/document.docx"},
]
```
3. Start listening for shortcuts:
```python
aukey.start_listening(shortcuts)
```
Using a JSON Configuration File
You can also load the configuration from a JSON file:
Create a JSON file with the following structure:
```json
[
{"name": "Open Notepad", "shortcut": "ctrlaltn", "type": "program", "path": "notepad.exe"},
{"name": "Open Google", "shortcut": "ctrlaltg", "type": "website", "path": "https://www.google.com"},
{"name": "Open a Document", "shortcut": "ctrlaltd", "type": "file", "path": "C:/path/to/document.docx"}
]
```
Start listening for shortcuts:
```python
aukey.start_listening("shortcuts.json")
```
## Configuration Details
Each shortcut in the configuration must include the following keys:
- name: A descriptive name for the action.
- shortcut: The keyboard shortcut combination (e.g., ctrlaltg).
- type: The type of action (program, file, or website).
- path: The path to the program, file, or URL.
Example Configuration
```python
shortcuts = [
{"name": "Open Notepad", "shortcut": "ctrlaltn", "type": "program", "path": "notepad.exe"},
{"name": "Open Google", "shortcut": "ctrlaltg", "type": "website", "path": "https://www.google.com"},
{"name": "Open a Document", "shortcut": "ctrlaltd", "type": "file", "path": "C:/path/to/document.docx"},
]
```
# Warnings
- Configuration Format: When adding a dictionary or JSON file as the configuration, ensure it follows this format:
```json
[
{"name": "", "shortcut": "altff", "type": "", "path": ""},
{"name": "", "shortcut": "altee", "type": "", "path": ""}
]
```
- ### Avoid Common Shortcuts: Do not use shortcuts that are already widely used by the system or applications, such as Ctrl+C, Ctrl+V, Ctrl+Z, etc. Using these might interfere with standard operations and cause unexpected behavior.
- ### on linux you need to run sudo python
## Contributing
Contributions are welcome! Please feel free to submit a pull request or open an issue on GitHub.
## License
This project is licensed under the MIT License - see the LICENSE file for details.
Raw data
{
"_id": null,
"home_page": null,
"name": "aukey",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "aukey",
"author": "Mostafa Mohamed Atef",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/c0/56/f89bc638a6a1e861c8dc541fedec730c1bfc7167411938b77e87d3337385/aukey-0.1.2.tar.gz",
"platform": null,
"description": "# aukey\n**aukey** is a Python package designed to execute programs, files, and websites using customizable keyboard shortcuts.\n\n## Features\n - Custom Shortcuts: Define custom keyboard shortcuts to execute programs, open files, or visit websites.\n - Flexible Configuration: Configure shortcuts using a dictionary or JSON file.\n - Multiple Action Types: Supports different action types, including executing programs, opening files, and launching URLs.\n - Cross-Platform Compatibility: Works on both Windows and Linux systems.\n - Installation\n - You can install aukey directly from PyPI using pip:\n\n## Installation\nYou can install aukey directly from PyPI using pip:\n\n```bash\npip install aukey\n```\n## Usage\nBasic Setup\n 1. Import the package:\n \n ```python\n import aukey\n ```\n 2. Create your shortcuts configuration:\n\n You can define your shortcuts directly in the code or use an external JSON file.\n Example configuration:\n \n ```python\n shortcuts = [\n {\"name\": \"Open Notepad\", \"shortcut\": \"ctrlaltn\", \"type\": \"program\", \"path\": \"notepad.exe\"},\n {\"name\": \"Open Google\", \"shortcut\": \"ctrlaltg\", \"type\": \"website\", \"path\": \"https://www.google.com\"},\n {\"name\": \"Open a Document\", \"shortcut\": \"ctrlaltd\", \"type\": \"file\", \"path\": \"C:/path/to/document.docx\"},\n ]\n ```\n 3. Start listening for shortcuts:\n\n ```python\n aukey.start_listening(shortcuts)\n ```\nUsing a JSON Configuration File\nYou can also load the configuration from a JSON file:\n\nCreate a JSON file with the following structure:\n\n```json\n[\n {\"name\": \"Open Notepad\", \"shortcut\": \"ctrlaltn\", \"type\": \"program\", \"path\": \"notepad.exe\"},\n {\"name\": \"Open Google\", \"shortcut\": \"ctrlaltg\", \"type\": \"website\", \"path\": \"https://www.google.com\"},\n {\"name\": \"Open a Document\", \"shortcut\": \"ctrlaltd\", \"type\": \"file\", \"path\": \"C:/path/to/document.docx\"}\n]\n```\nStart listening for shortcuts:\n\n```python\naukey.start_listening(\"shortcuts.json\")\n```\n## Configuration Details\nEach shortcut in the configuration must include the following keys:\n\n - name: A descriptive name for the action.\n - shortcut: The keyboard shortcut combination (e.g., ctrlaltg).\n - type: The type of action (program, file, or website).\n - path: The path to the program, file, or URL.\nExample Configuration\n\n```python\nshortcuts = [\n {\"name\": \"Open Notepad\", \"shortcut\": \"ctrlaltn\", \"type\": \"program\", \"path\": \"notepad.exe\"},\n {\"name\": \"Open Google\", \"shortcut\": \"ctrlaltg\", \"type\": \"website\", \"path\": \"https://www.google.com\"},\n {\"name\": \"Open a Document\", \"shortcut\": \"ctrlaltd\", \"type\": \"file\", \"path\": \"C:/path/to/document.docx\"},\n]\n```\n# Warnings\n - Configuration Format: When adding a dictionary or JSON file as the configuration, ensure it follows this format:\n \n ```json\n [\n {\"name\": \"\", \"shortcut\": \"altff\", \"type\": \"\", \"path\": \"\"},\n {\"name\": \"\", \"shortcut\": \"altee\", \"type\": \"\", \"path\": \"\"}\n ]\n ```\n - ### Avoid Common Shortcuts: Do not use shortcuts that are already widely used by the system or applications, such as Ctrl+C, Ctrl+V, Ctrl+Z, etc. Using these might interfere with standard operations and cause unexpected behavior.\n\n - ### on linux you need to run sudo python \n\n## Contributing\nContributions are welcome! Please feel free to submit a pull request or open an issue on GitHub.\n\n## License\nThis project is licensed under the MIT License - see the LICENSE file for details.\n\n",
"bugtrack_url": null,
"license": "MIT license",
"summary": "A package for executing programs, files, websites by using shortcuts.",
"version": "0.1.2",
"project_urls": null,
"split_keywords": [
"aukey"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "99f7ee43495e9386f678f7d1a9d95ebb1dd25d01ebb431af323d52754c77a2b9",
"md5": "d0c604216d4faa60b9a6e82322f84138",
"sha256": "c9da68f3717f66937a3e86927df5a0a30c4683dc23f2acd98f1bc70c78da7206"
},
"downloads": -1,
"filename": "aukey-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d0c604216d4faa60b9a6e82322f84138",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4237,
"upload_time": "2024-08-28T16:35:16",
"upload_time_iso_8601": "2024-08-28T16:35:16.166188Z",
"url": "https://files.pythonhosted.org/packages/99/f7/ee43495e9386f678f7d1a9d95ebb1dd25d01ebb431af323d52754c77a2b9/aukey-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c056f89bc638a6a1e861c8dc541fedec730c1bfc7167411938b77e87d3337385",
"md5": "b4853f4d88cd131742c1b8058cf4bc5c",
"sha256": "388d886fc7291f0df906be0e4e05845b02cecb4f5bd6b62a3e422fb1ddfc39df"
},
"downloads": -1,
"filename": "aukey-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "b4853f4d88cd131742c1b8058cf4bc5c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 8326,
"upload_time": "2024-08-28T16:35:19",
"upload_time_iso_8601": "2024-08-28T16:35:19.577684Z",
"url": "https://files.pythonhosted.org/packages/c0/56/f89bc638a6a1e861c8dc541fedec730c1bfc7167411938b77e87d3337385/aukey-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-28 16:35:19",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "aukey"
}
