textual-filedrop

v0.3.5

FileDrop widget for Textual, easily drag and drop files into your terminal apps. For more information about how to use this package see README

Latest version published 2 years ago

License: MIT

PyPI

GitHub

Package Health Score

66 / 100

security
No known security issues
popularity
Small
maintenance
Inactive
community
Active

Explore Similar Packages

Popularity

Small

GitHub Stars: 25.66K
Forks: 791
Contributors: 150

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package textual-filedrop, we found that it has been starred 25,663 times.

Security

No known security issues

Security and license risk for latest version

Release Date: Mar 22, 2023
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
0
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

MIT

Security Policy

We found a way for you to contribute to the project! Looks like textual-filedrop is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Inactive

Commit Frequency

Open Issues: 137
Open PR: 30
Last Release: 2 years ago
Last Commit: 7 days ago

Further analysis of the maintenance status of textual-filedrop based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for textual-filedrop is that it hasn't seen any new versions released to PyPI in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Active

Readme: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 150
Funding: No

A good and healthy external contribution signal for textual-filedrop project, which invites more than one hundred open source maintainers to collaborate on the repository.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: >=3.7.8,<4.0.0

Age: 2 years
Latest Release: 2 years ago
Dependencies: 2 Direct
Versions: 10
Maintainers: 1
Wheels: OS Independent

Readme

textual-filedrop

Add filedrop support to your Textual apps, easily drag and drop files into your terminal apps.

Tested on Windows and macOS.

Nerd Font is required to display file icons.

Install

pip install textual-filedrop

git clone https://github.com/agmmnn/textual-filedrop.git
cd textual-filedrop
poetry install

Note

Since version 0.10.0 Textual supports bubble for the paste event (Textualize/textual#1434). So if the terminal where your app is running treats the file drag and drop as a paste event, you can catch it yourself with the on_paste function without widget.

Usage

`getfiles`

getfiles returns an object containing the path, filename, extension and icon of the files.

from textual_filedrop import getfiles

class MyApp(App):
...
    def on_paste(self, event) -> None:
        files = getfiles(event)
        print(files)

`FileDrop` Widget

As long as the FileDrop widget is in focus, it will give the information of the dragged files and render the file names with their icons on the screen.

from textual_filedrop import FileDrop

# add FileDrop widget to your app
yield FileDrop(id="filedrop")

# focus the widget
self.query_one("#filedrop").focus()

# when the files are dropped
def on_file_drop_dropped(self, message: FileDrop.Dropped) -> None:
    path = message.path
    filepaths = message.filepaths
    filenames = message.filenames
    filesobj = message.filesobj
    print(path, filepaths, filenames, filesobj)


# output: path, [filepaths], [filenames], [filesobj]

You can find more examples here.

Examples

subdomain_lister.py

Drag and drop the subdomain list files and see the results as a tree list.

subdomain_lister

fullscreen.py

Fullscreen example, will show the results in the textual console.

hidden.py

As long as focus is on, the FileDrop widget will be active even if it is not visible on the screen.

without_widget.py

An example that renders the object with the information of the dragged files returned from the getfiles function to the screen with rich.json.

Dev

poetry install

textual console
poetry run textual run --dev examples/subdomain_lister.py

textual-filedrop dependencies

rich textual

FAQs

What is textual-filedrop?

FileDrop widget for Textual, easily drag and drop files into your terminal apps. Visit Snyk Advisor to see a full health score report for textual-filedrop, including popularity, security, maintenance & community analysis.

Is textual-filedrop popular?

The python package textual-filedrop receives a total of 86 weekly downloads. As such, textual-filedrop popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is textual-filedrop well maintained?

We found indications that textual-filedrop is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is textual-filedrop safe to use?

The python package textual-filedrop was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 18 November-2024, at 11:11 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Direct Usage Popularity

Security and license risk for latest version

Commit Frequency

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Readme

textual-filedrop

Install

Note

Usage

getfiles

FileDrop Widget

Examples

subdomain_lister.py

fullscreen.py

hidden.py

without_widget.py

Dev

textual-filedrop dependencies

FAQs

What is textual-filedrop?

Is textual-filedrop popular?

Is textual-filedrop well maintained?

Is textual-filedrop safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues

`getfiles`

`FileDrop` Widget