# Starlyng Smart Log Rotation
This project manages servers by automatically rotating logs after a certain amount of time.
## Prerequisites
Before you begin, ensure you have met the following requirements:
* Python 3.x installed
* Basic understanding of Python and virtual environments
## Running
### Using VSCode/Cursor
**Run the Program:**
- Go to the Run and Debug view (⌘+Shift+D, or Ctrl+Shift+D on Windows)
- Select the pre-configured launch configuration from the dropdown menu
- Click the green play button (F5) or use the "Run" menu to start the program
## Setting Up Your Development Environment
1. Clone the repository:
```bash
git clone https://github.com/starlyngapp/smart-log-rotation.git
cd smart-log-rotation
```
2. Setup Environment for VSCode:
* Open the Command Palette (Ctrl+Shift+P)
* Search for the Python: Create Environment command, and select it
* Select Venv
* Select Python interpreter
* Select dependencies to install
3. Install Required Packages
Install all dependencies listed in the dev-requirements.txt file:
```bash
pip install -r dev-requirements.txt
```
## Installation
To install only the package (without dev dependencies):
```bash
pip install starlyng_smart_log_rotation
```
To install development dependencies (useful for contributing to the project):
```bash
pip install starlyng_smart_log_rotation[dev]
```
Alternatively, you can install the development dependencies using:
```bash
pip install -r dev-requirements.txt
```
## Create and activate a virtual environment:
* macOS/Linux:
```bash
python -m venv venv
source venv/bin/activate
```
* Windows:
```bash
python -m venv venv
venv\Scripts\activate
```
## Releases to PyPi
This should be done through creating a new release in GitHub
## Environment Configuration
To configure smart log rotation, you need to set up environment variables. This can be done by creating a `.env` file in the root of the project.
An example `.env` file is provided as `.env.example`. You can copy this file and update the values as needed.
### Steps to Configure Environment Variables
1. **Copy the example environment file:**
```sh
cp .env.example .env
```
2. **Open the `.env` file and update the values:**
```env
# List of server IPs and ports in the format ip:port, separated by commas
SERVERS=192.168.1.1:22,192.168.1.2:22
# Set to true if the servers are accessed via public IP addresses instead of local network
PUBLIC_IP=false
# Base hostname used for generating server hostnames in the format {hostname}{host_id}
SSH_BASE_HOSTNAME=server
# Path to the SSH private key
SSH_KEY_PATH=/path/to/your/.ssh/id_rsa
# SSH username
SSH_USER=your_ssh_username
```
3. **Save the `.env` file.**
The `SERVERS` variable should be a comma-separated list of server IP addresses and ports.
## Usage
To run the main function:
```bash
smart_log_rotation
```
## PyPI
[starlyng-smart-log-rotation](https://pypi.org/project/starlyng-smart-log-rotation/)
## Command-line Arguments
You can also override configuration using command-line arguments:
```bash
smart_log_rotation --servers "192.168.1.1:22,192.168.1.2:22" --public_ip "false" --ssh_base_hostname "server" --ssh_key_path "/path/to/your/.ssh/id_rsa" --ssh_user "your_ssh_username"
```
Or locally:
```bash
python main.py --servers "192.168.1.1:22,192.168.1.2:22" --public_ip "false" --ssh_base_hostname "server" --ssh_key_path "/path/to/your/.ssh/id_rsa" --ssh_user "your_ssh_username"
```
### Building and Uploading Your Package
1. **Build the package**:
```bash
python setup.py sdist bdist_wheel
```
2. **Upload to PyPI**:
```bash
twine upload dist/*
```
Upload using specific project name referenced in .pypirc
```bash
twine upload dist/* --repository starlyng-smart-log-rotation
```
## Running Tests
To run tests, execute the following command in your terminal:
```bash
pytest
```
This command will run all tests and report the results. You can also run specific tests by providing the path and filename of the test file.
## Contributing to the Project
Contributions to this project are welcome. Here's how you can contribute:
1. Fork the project.
2. Create your feature branch (git checkout -b feature/YourFeature).
3. Commit your changes (git commit -am 'Add some YourFeature').
4. Push to the branch (git push origin feature/YourFeature).
5. Open a pull request.
## Contact
If you have any questions, please contact:
- GitHub: [@justinsherwood](https://github.com/justinsherwood)
Raw data
{
"_id": null,
"home_page": "https://github.com/starlyngapp/smart-log-rotation",
"name": "starlyng-smart-log-rotation",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "log rotation ssh remote server management automation system administration devops log management",
"author": "Justin Sherwood",
"author_email": "justin@sherwood.fm",
"download_url": "https://files.pythonhosted.org/packages/9d/50/cc39275e5cbf8661561893891cd37e669ef4da66deef1f19481a1ecee3df/starlyng_smart_log_rotation-0.0.2.tar.gz",
"platform": null,
"description": "# Starlyng Smart Log Rotation\n\nThis project manages servers by automatically rotating logs after a certain amount of time.\n\n## Prerequisites\n\nBefore you begin, ensure you have met the following requirements:\n* Python 3.x installed\n* Basic understanding of Python and virtual environments\n\n## Running\n\n### Using VSCode/Cursor\n\n**Run the Program:**\n - Go to the Run and Debug view (\u2318+Shift+D, or Ctrl+Shift+D on Windows)\n - Select the pre-configured launch configuration from the dropdown menu\n - Click the green play button (F5) or use the \"Run\" menu to start the program\n\n## Setting Up Your Development Environment\n\n1. Clone the repository:\n ```bash\n git clone https://github.com/starlyngapp/smart-log-rotation.git\n cd smart-log-rotation\n ```\n\n2. Setup Environment for VSCode:\n\n* Open the Command Palette (Ctrl+Shift+P)\n* Search for the Python: Create Environment command, and select it\n* Select Venv\n* Select Python interpreter\n* Select dependencies to install\n\n3. Install Required Packages\n\nInstall all dependencies listed in the dev-requirements.txt file:\n\n```bash\npip install -r dev-requirements.txt\n```\n\n## Installation\n\nTo install only the package (without dev dependencies):\n\n```bash\npip install starlyng_smart_log_rotation\n```\n\nTo install development dependencies (useful for contributing to the project):\n\n```bash\npip install starlyng_smart_log_rotation[dev]\n```\n\nAlternatively, you can install the development dependencies using:\n\n```bash\npip install -r dev-requirements.txt\n```\n\n## Create and activate a virtual environment:\n * macOS/Linux:\n ```bash\n python -m venv venv\n source venv/bin/activate\n ```\n * Windows:\n ```bash\n python -m venv venv\n venv\\Scripts\\activate\n ```\n\n## Releases to PyPi\n\nThis should be done through creating a new release in GitHub\n\n## Environment Configuration\n\nTo configure smart log rotation, you need to set up environment variables. This can be done by creating a `.env` file in the root of the project.\n\nAn example `.env` file is provided as `.env.example`. You can copy this file and update the values as needed.\n\n### Steps to Configure Environment Variables\n\n1. **Copy the example environment file:**\n\n```sh\ncp .env.example .env\n```\n\n2. **Open the `.env` file and update the values:**\n\n```env\n# List of server IPs and ports in the format ip:port, separated by commas\nSERVERS=192.168.1.1:22,192.168.1.2:22\n\n# Set to true if the servers are accessed via public IP addresses instead of local network\nPUBLIC_IP=false\n\n# Base hostname used for generating server hostnames in the format {hostname}{host_id}\nSSH_BASE_HOSTNAME=server\n\n# Path to the SSH private key\nSSH_KEY_PATH=/path/to/your/.ssh/id_rsa\n\n# SSH username\nSSH_USER=your_ssh_username\n```\n\n3. **Save the `.env` file.**\n\nThe `SERVERS` variable should be a comma-separated list of server IP addresses and ports.\n\n## Usage\n\nTo run the main function:\n\n```bash\nsmart_log_rotation\n```\n\n## PyPI\n\n[starlyng-smart-log-rotation](https://pypi.org/project/starlyng-smart-log-rotation/)\n\n## Command-line Arguments\n\nYou can also override configuration using command-line arguments:\n\n```bash\nsmart_log_rotation --servers \"192.168.1.1:22,192.168.1.2:22\" --public_ip \"false\" --ssh_base_hostname \"server\" --ssh_key_path \"/path/to/your/.ssh/id_rsa\" --ssh_user \"your_ssh_username\"\n```\n\nOr locally:\n\n```bash\npython main.py --servers \"192.168.1.1:22,192.168.1.2:22\" --public_ip \"false\" --ssh_base_hostname \"server\" --ssh_key_path \"/path/to/your/.ssh/id_rsa\" --ssh_user \"your_ssh_username\"\n```\n\n### Building and Uploading Your Package\n\n1. **Build the package**:\n\n```bash\npython setup.py sdist bdist_wheel\n```\n\n2. **Upload to PyPI**:\n\n```bash\ntwine upload dist/*\n```\n\nUpload using specific project name referenced in .pypirc\n\n```bash\ntwine upload dist/* --repository starlyng-smart-log-rotation\n```\n\n## Running Tests\n\nTo run tests, execute the following command in your terminal:\n\n```bash\npytest\n```\n\nThis command will run all tests and report the results. You can also run specific tests by providing the path and filename of the test file.\n\n## Contributing to the Project\n\nContributions to this project are welcome. Here's how you can contribute:\n\n1. Fork the project.\n2. Create your feature branch (git checkout -b feature/YourFeature).\n3. Commit your changes (git commit -am 'Add some YourFeature').\n4. Push to the branch (git push origin feature/YourFeature).\n5. Open a pull request.\n\n## Contact\n\nIf you have any questions, please contact:\n\n- GitHub: [@justinsherwood](https://github.com/justinsherwood)\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Manage servers by rotating logs after a certain amount of time.",
"version": "0.0.2",
"project_urls": {
"Homepage": "https://github.com/starlyngapp/smart-log-rotation"
},
"split_keywords": [
"log",
"rotation",
"ssh",
"remote",
"server",
"management",
"automation",
"system",
"administration",
"devops",
"log",
"management"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bfb33b62d3e5b44d480fedd241c4667384081ed9ccad496d8b56caf8e4249a7e",
"md5": "6fb5fd51aff8befd3d949303d86f8698",
"sha256": "f62531b20863e16675f8ccf9252b248e143b3723e923578c1c53d2ba66f9dded"
},
"downloads": -1,
"filename": "starlyng_smart_log_rotation-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6fb5fd51aff8befd3d949303d86f8698",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 4263,
"upload_time": "2024-12-21T21:50:29",
"upload_time_iso_8601": "2024-12-21T21:50:29.232473Z",
"url": "https://files.pythonhosted.org/packages/bf/b3/3b62d3e5b44d480fedd241c4667384081ed9ccad496d8b56caf8e4249a7e/starlyng_smart_log_rotation-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9d50cc39275e5cbf8661561893891cd37e669ef4da66deef1f19481a1ecee3df",
"md5": "7e8dba8be76a82903f1e4985f538200a",
"sha256": "722c5400ca44ff3b43d4ae601526f0ca84ae50e1a0d9bd78c909d77db5f31d9f"
},
"downloads": -1,
"filename": "starlyng_smart_log_rotation-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "7e8dba8be76a82903f1e4985f538200a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 3883,
"upload_time": "2024-12-21T21:50:31",
"upload_time_iso_8601": "2024-12-21T21:50:31.240233Z",
"url": "https://files.pythonhosted.org/packages/9d/50/cc39275e5cbf8661561893891cd37e669ef4da66deef1f19481a1ecee3df/starlyng_smart_log_rotation-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-21 21:50:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "starlyngapp",
"github_project": "smart-log-rotation",
"github_not_found": true,
"lcname": "starlyng-smart-log-rotation"
}
JSON
