offlix 0.1.0b0

A tool to install and start Docker services using Docker Compose.

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
• Installation
• Usage
• Commands
• Environment Variables
• Contributing
• 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:

pip install offlix

Usage

Once Offlix is installed, you can use it from the command line. Here’s how to get started:

offlix <command> <service_name>

Commands

Install a Service:

offlix install mysql

Uninstall a Service:

offlix uninstall mysql

Stop a Service:

offlix stop mysql

Example

To install MySQL and retrieve its environment variables:

offlix install mysql

After installation, to get the environment variables:

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:

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.