| Name | offlix JSON |
| Version |
0.1.5.1
JSON |
| download |
| home_page | https://github.com/sumanmanna134/offlix-cli |
| Summary | Offlix is a command-line tool designed to simplify the deployment and management of common services using Docker Compose. With Offlix, you can easily install, uninstall, and retrieve environment variables for services like MySQL, MongoDB, Kafka, Maildev, and PostgreSQL, etc |
| upload_time | 2024-11-05 08:16:56 |
| maintainer | None |
| docs_url | None |
| author | Suman Manna |
| requires_python | >=3.6 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<!-- # Installation Script for Development Tools
This project provides a Bash script that automates the installation of several essential development tools on Linux-based systems. The script installs the following:
- **Node.js (LTS version)**
- **Git**
- **IntelliJ IDEA Community Edition**
- **Visual Studio Code**
- **OpenJDK 17**
## Prerequisites
Before running the script, ensure that your system has the following:
- **Bash shell**: The script is designed to run in a Bash environment.
- **Root access**: You will need `sudo` or root privileges to install packages.
## Supported Linux Distributions
The script supports most popular Linux distributions, including:
- Ubuntu and other **Debian-based distributions** (using `apt`)
- Fedora and other **Red Hat-based distributions** (using `dnf`)
- CentOS and other **RHEL-based distributions** (using `yum`)
For IntelliJ IDEA and Visual Studio Code, the script uses **Snap**. If Snap is not installed on your system, the script will attempt to install it.
## Download the Script
First, clone this repository or download the script directly:
```bash
git clone https://github.com/yourusername/dev-tools-installer.git
cd dev-tools-installer
```
## How to Use for Linux
### 2. Make the Script Executable
```
chmod +x install.sh
```
Run the Bash Script
Run the script with `sudo`:
```
sudo ./install.sh
```
## How to Use for Windows
### 1. Set Execution Policy (if needed)
Before running the script, you might need to change the PowerShell execution policy:
Check the current policy:
```
Get-ExecutionPolicy
```
Set the execution policy to allow running scripts:
```
Set-ExecutionPolicy RemoteSigned
```
You may need to confirm the change by typing `Y`.
### 2. Run the PowerShell Script
Navigate to the folder containing the script, and then run it:
```
.\install.ps1
```
## Verify Installation
Check that the tools have been installed:
### Nodejs
```
node -v
```
### Git
```
git --version
```
### IntelliJ IDEA: Launch from your application menu or using:
```
intellij-idea-community
```
### OpenJDK 17
```
java -version
``` -->
# Offlix
Offlix is a command-line tool designed to simplify the deployment and management of common services using Docker Compose. With Offlix, you can easily install, uninstall, and retrieve environment variables for services like MySQL, MongoDB, Kafka, Maildev, and PostgreSQL.
## Table of Contents
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Commands](#commands)
- [Environment Variables](#environment-variables)
- [Contributing](#contributing)
- [License](#license)
## Features
- **Easy Installation**: Quickly deploy common services with predefined Docker Compose configurations.
- **Service Management**: Start, stop, and uninstall services with simple commands.
- **Environment Variable Retrieval**: Automatically fetch and display environment variables after service installation.
- **Custom Configurations**: Support for custom Docker Compose files for advanced users.
## Installation
To install Offlix, use pip:
```bash
pip install offlix
```
## Usage
Once Offlix is installed, you can use it from the command line. Here’s how to get started:
```bash
offlix <command> <service_name>
```
## Commands
### Install a Service:
```bash
offlix install mysql
```
### Uninstall a Service:
```bash
offlix uninstall mysql
```
### Stop a Service:
```bash
offlix stop mysql
```
### Example
### To install MySQL and retrieve its environment variables:
```bash
offlix install mysql
```
### After installation, to get the environment variables:
```python
from offlix import get_service_env
env_vars = get_service_env('mysql')
print(env_vars)
```
### Environment Variables
After installing a service with Docker, you can retrieve its environment variables (like username, password, etc.) using the following command:
```python
from offlix import get_service_env
# Retrieve environment variables for MySQL
mysql_env = get_service_env('mysql')
print(mysql_env)
```
This will display relevant configuration settings required for connecting to the service.
## Contributing
Contributions are welcome! If you have suggestions for improvements or want to report bugs, please open an issue or create a pull request.
Fork the repository.
Create a new branch (git checkout -b feature-branch).
Make your changes and commit them (git commit -m 'Add new feature').
Push to the branch (git push origin feature-branch).
Open a pull request.
## License
This project is licensed under the MIT License. See the LICENSE file for more details.
This project is licensed under the terms of the [MIT License](LICENSE).
Raw data
{
"_id": null,
"home_page": "https://github.com/sumanmanna134/offlix-cli",
"name": "offlix",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "Suman Manna",
"author_email": "manna.suman134@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ec/71/f5f1a2071788cb67a0ca52e2df740573dcd70a5760e7596017bbdcdbf90e/offlix-0.1.5.1.tar.gz",
"platform": null,
"description": "<!-- # Installation Script for Development Tools\n\nThis project provides a Bash script that automates the installation of several essential development tools on Linux-based systems. The script installs the following:\n\n- **Node.js (LTS version)**\n- **Git**\n- **IntelliJ IDEA Community Edition**\n- **Visual Studio Code**\n- **OpenJDK 17**\n\n## Prerequisites\n\nBefore running the script, ensure that your system has the following:\n\n- **Bash shell**: The script is designed to run in a Bash environment.\n- **Root access**: You will need `sudo` or root privileges to install packages.\n\n## Supported Linux Distributions\n\nThe script supports most popular Linux distributions, including:\n\n- Ubuntu and other **Debian-based distributions** (using `apt`)\n- Fedora and other **Red Hat-based distributions** (using `dnf`)\n- CentOS and other **RHEL-based distributions** (using `yum`)\n\nFor IntelliJ IDEA and Visual Studio Code, the script uses **Snap**. If Snap is not installed on your system, the script will attempt to install it.\n\n## Download the Script\n\nFirst, clone this repository or download the script directly:\n\n```bash\ngit clone https://github.com/yourusername/dev-tools-installer.git\ncd dev-tools-installer\n```\n\n## How to Use for Linux\n\n### 2. Make the Script Executable\n\n```\nchmod +x install.sh\n```\n\nRun the Bash Script\nRun the script with `sudo`:\n\n```\nsudo ./install.sh\n```\n\n## How to Use for Windows\n\n### 1. Set Execution Policy (if needed)\n\nBefore running the script, you might need to change the PowerShell execution policy:\n\nCheck the current policy:\n\n```\nGet-ExecutionPolicy\n\n```\n\nSet the execution policy to allow running scripts:\n\n```\nSet-ExecutionPolicy RemoteSigned\n\n```\n\nYou may need to confirm the change by typing `Y`.\n\n### 2. Run the PowerShell Script\n\nNavigate to the folder containing the script, and then run it:\n\n```\n.\\install.ps1\n```\n\n## Verify Installation\n\nCheck that the tools have been installed:\n\n### Nodejs\n\n```\nnode -v\n\n```\n\n### Git\n\n```\ngit --version\n\n```\n\n### IntelliJ IDEA: Launch from your application menu or using:\n\n```\nintellij-idea-community\n\n```\n\n### OpenJDK 17\n\n```\njava -version\n\n``` -->\n\n# Offlix\n\nOfflix is a command-line tool designed to simplify the deployment and management of common services using Docker Compose. With Offlix, you can easily install, uninstall, and retrieve environment variables for services like MySQL, MongoDB, Kafka, Maildev, and PostgreSQL.\n\n## Table of Contents\n\n- [Features](#features)\n- [Installation](#installation)\n- [Usage](#usage)\n- [Commands](#commands)\n- [Environment Variables](#environment-variables)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Features\n\n- **Easy Installation**: Quickly deploy common services with predefined Docker Compose configurations.\n- **Service Management**: Start, stop, and uninstall services with simple commands.\n- **Environment Variable Retrieval**: Automatically fetch and display environment variables after service installation.\n- **Custom Configurations**: Support for custom Docker Compose files for advanced users.\n\n## Installation\n\nTo install Offlix, use pip:\n\n```bash\npip install offlix\n\n```\n\n## Usage\n\nOnce Offlix is installed, you can use it from the command line. Here\u2019s how to get started:\n\n```bash\nofflix <command> <service_name>\n```\n\n## Commands\n\n### Install a Service:\n\n```bash\nofflix install mysql\n```\n\n### Uninstall a Service:\n\n```bash\nofflix uninstall mysql\n```\n\n### Stop a Service:\n\n```bash\nofflix stop mysql\n```\n\n### Example\n\n### To install MySQL and retrieve its environment variables:\n\n```bash\nofflix install mysql\n```\n\n### After installation, to get the environment variables:\n\n```python\nfrom offlix import get_service_env\nenv_vars = get_service_env('mysql')\nprint(env_vars)\n```\n\n### Environment Variables\n\nAfter installing a service with Docker, you can retrieve its environment variables (like username, password, etc.) using the following command:\n\n```python\nfrom offlix import get_service_env\n\n# Retrieve environment variables for MySQL\n\nmysql_env = get_service_env('mysql')\nprint(mysql_env)\n```\n\nThis will display relevant configuration settings required for connecting to the service.\n\n## Contributing\n\nContributions are welcome! If you have suggestions for improvements or want to report bugs, please open an issue or create a pull request.\n\nFork the repository.\n\nCreate a new branch (git checkout -b feature-branch).\nMake your changes and commit them (git commit -m 'Add new feature').\n\nPush to the branch (git push origin feature-branch).\nOpen a pull request.\n\n## License\n\nThis project is licensed under the MIT License. See the LICENSE file for more details.\n\nThis project is licensed under the terms of the [MIT License](LICENSE).\n",
"bugtrack_url": null,
"license": null,
"summary": "Offlix is a command-line tool designed to simplify the deployment and management of common services using Docker Compose. With Offlix, you can easily install, uninstall, and retrieve environment variables for services like MySQL, MongoDB, Kafka, Maildev, and PostgreSQL, etc",
"version": "0.1.5.1",
"project_urls": {
"Homepage": "https://github.com/sumanmanna134/offlix-cli"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "aa8207c5c34ff69a163b7a0566cc89e0c9878c9bc8833949ad5765e9b870bf9a",
"md5": "0ec1fc46e087916ae5cdf5ef0523999d",
"sha256": "e364218592c8dc4ab3d17266dd9e3372f14ecf76dd1093c6105f1111849fc8c6"
},
"downloads": -1,
"filename": "offlix-0.1.5.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0ec1fc46e087916ae5cdf5ef0523999d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 9566,
"upload_time": "2024-11-05T08:16:54",
"upload_time_iso_8601": "2024-11-05T08:16:54.916704Z",
"url": "https://files.pythonhosted.org/packages/aa/82/07c5c34ff69a163b7a0566cc89e0c9878c9bc8833949ad5765e9b870bf9a/offlix-0.1.5.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ec71f5f1a2071788cb67a0ca52e2df740573dcd70a5760e7596017bbdcdbf90e",
"md5": "e70ac281db581a76d665129238d49793",
"sha256": "98bf9e588bff14e69d86632147264ab7092686a86288e70ffa8d92ada0a822c6"
},
"downloads": -1,
"filename": "offlix-0.1.5.1.tar.gz",
"has_sig": false,
"md5_digest": "e70ac281db581a76d665129238d49793",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 8799,
"upload_time": "2024-11-05T08:16:56",
"upload_time_iso_8601": "2024-11-05T08:16:56.059203Z",
"url": "https://files.pythonhosted.org/packages/ec/71/f5f1a2071788cb67a0ca52e2df740573dcd70a5760e7596017bbdcdbf90e/offlix-0.1.5.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-05 08:16:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sumanmanna134",
"github_project": "offlix-cli",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "offlix"
}
