Skip to main content

Symply - Advanced Symlink Management and Monitoring

Symply is a Python library designed to provide robust symlink creation, deletion, and monitoring functionality. It helps developers handle file system events efficiently and perform specific actions based on those events, such as creating or managing symlinks dynamically.

Features

  • Symlink Management: Easily create and delete symlinks using straightforward Python functions.
  • File System Monitoring: Monitor directories for changes like creation, deletion, modification, and moving of files or directories.
  • Event-Driven Actions: Execute custom actions based on file system events using user-defined callback functions.
  • Customizable Filters: Specify which files to monitor based on patterns, enhancing the flexibility and efficiency of the monitoring process.

Installation

To install Symply, clone this repository and include it in your project, or use pip to install directly from the source:

pip install symply

Usage

from symply import symlink

symlink('/path/to/source', '/path/to/target', force=True)
from symply import delete_symlink

delete_symlink('/path/to/target')

File System Monitoring

Set up monitoring to react to file system events:

from symply.watcher import SymlinkMonitor, SymlinkHandler

def handle_event(path, event_type, destination=None):
    print(f"Event: {event_type}, Path: {path}")
    if destination:
        print(f"Destination: {destination}")

handler = SymlinkHandler(handle_event)
monitor = SymlinkMonitor('/path/to/watch', handler)
monitor.start()

Stop Monitoring

input("Monitoring... Press Enter to stop.\n")
monitor.stop()

Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'feat: Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Metadata

Release files for symply 0.1.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for symply 0.1.2
File Size Uploaded Provenance Actions
symply-0.1.2.tar.gz 5.0 kB Without provenance Details for symply-0.1.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for symply 0.1.2
File Interpreter ABI Platform Actions
symply-0.1.2-py3-none-any.whl Python 3 none any Details for symply-0.1.2-py3-none-any.whl

Total release size: 11.2 kB

Release files / symply-0.1.2.tar.gz

Download URL symply-0.1.2.tar.gz
Size 5.0 kB
Tags Source
SHA-256 checksum
How to use checksums
8c3c5e940f5de0c3781db7b6d03a14cffc18fdceeb0e77a9309a817ce87e5cbf
BLAKE2b-256 checksum
How to use checksums
b26e7b6761c7fd47451729e0ff091ee4a17ed905014d1a562064bcb5932a379e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.8.2 CPython/3.11.2 Linux/5.15.146.1-microsoft-standard-WSL2

Release files / symply-0.1.2-py3-none-any.whl

Download URL symply-0.1.2-py3-none-any.whl
Size 6.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
15b05c14038bb700a5a9369bc051743879a9d343401d85da5a51b86a8998bb02
BLAKE2b-256 checksum
How to use checksums
33eacc38e89a0c563d98c368902408652c9e012e537333c3b81aacaf55fc56d6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.8.2 CPython/3.11.2 Linux/5.15.146.1-microsoft-standard-WSL2

Security for symply 0.1.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page