f2-commander 0.1.0__tar.gz

f2_commander-0.1.0/LICENSE

@@ -0,0 +1,374 @@
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+    means each individual or legal entity that creates, contributes to
+    the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+    means the combination of the Contributions of others (if any) used
+    by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+    means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+    means Source Code Form to which the initial Contributor has attached
+    the notice in Exhibit A, the Executable Form of such Source Code
+    Form, and Modifications of such Source Code Form, in each case
+    including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+    means
+
+    (a) that the initial Contributor has attached the notice described
+        in Exhibit B to the Covered Software; or
+
+    (b) that the Covered Software was made available under the terms of
+        version 1.1 or earlier of the License, but not also under the
+        terms of a Secondary License.
+
+1.6. "Executable Form"
+    means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+    means a work that combines Covered Software with other material, in
+    a separate file or files, that is not Covered Software.
+
+1.8. "License"
+    means this document.
+
+1.9. "Licensable"
+    means having the right to grant, to the maximum extent possible,
+    whether at the time of the initial grant or subsequently, any and
+    all of the rights conveyed by this License.
+
+1.10. "Modifications"
+    means any of the following:
+
+    (a) any file in Source Code Form that results from an addition to,
+        deletion from, or modification of the contents of Covered
+        Software; or
+
+    (b) any new file in Source Code Form that contains any Covered
+        Software.
+
+1.11. "Patent Claims" of a Contributor
+    means any patent claim(s), including without limitation, method,
+    process, and apparatus claims, in any patent Licensable by such
+    Contributor that would be infringed, but for the grant of the
+    License, by the making, using, selling, offering for sale, having
+    made, import, or transfer of either its Contributions or its
+    Contributor Version.
+
+1.12. "Secondary License"
+    means either the GNU General Public License, Version 2.0, the GNU
+    Lesser General Public License, Version 2.1, the GNU Affero General
+    Public License, Version 3.0, or any later versions of those
+    licenses.
+
+1.13. "Source Code Form"
+    means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+    means an individual or a legal entity exercising rights under this
+    License. For legal entities, "You" includes any entity that
+    controls, is controlled by, or is under common control with You. For
+    purposes of this definition, "control" means (a) the power, direct
+    or indirect, to cause the direction or management of such entity,
+    whether by contract or otherwise, or (b) ownership of more than
+    fifty percent (50%) of the outstanding shares or beneficial
+    ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+    Licensable by such Contributor to use, reproduce, make available,
+    modify, display, perform, distribute, and otherwise exploit its
+    Contributions, either on an unmodified basis, with Modifications, or
+    as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+    for sale, have made, import, and otherwise transfer either its
+    Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+    or
+
+(b) for infringements caused by: (i) Your and any other third party's
+    modifications of Covered Software, or (ii) the combination of its
+    Contributions with other software (except as part of its Contributor
+    Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+    its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+    Form, as described in Section 3.1, and You must inform recipients of
+    the Executable Form how they can obtain a copy of such Source Code
+    Form by reasonable means in a timely manner, at a charge no more
+    than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+    License, or sublicense it under different terms, provided that the
+    license for the Executable Form does not attempt to limit or alter
+    the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+*                                                                      *
+*  6. Disclaimer of Warranty                                           *
+*  -------------------------                                           *
+*                                                                      *
+*  Covered Software is provided under this License on an "as is"       *
+*  basis, without warranty of any kind, either expressed, implied, or  *
+*  statutory, including, without limitation, warranties that the       *
+*  Covered Software is free of defects, merchantable, fit for a        *
+*  particular purpose or non-infringing. The entire risk as to the     *
+*  quality and performance of the Covered Software is with You.        *
+*  Should any Covered Software prove defective in any respect, You     *
+*  (not any Contributor) assume the cost of any necessary servicing,   *
+*  repair, or correction. This disclaimer of warranty constitutes an   *
+*  essential part of this License. No use of any Covered Software is   *
+*  authorized under this License except under this disclaimer.         *
+*                                                                      *
+************************************************************************
+
+************************************************************************
+*                                                                      *
+*  7. Limitation of Liability                                          *
+*  --------------------------                                          *
+*                                                                      *
+*  Under no circumstances and under no legal theory, whether tort      *
+*  (including negligence), contract, or otherwise, shall any           *
+*  Contributor, or anyone who distributes Covered Software as          *
+*  permitted above, be liable to You for any direct, indirect,         *
+*  special, incidental, or consequential damages of any character      *
+*  including, without limitation, damages for lost profits, loss of    *
+*  goodwill, work stoppage, computer failure or malfunction, or any    *
+*  and all other commercial damages or losses, even if such party      *
+*  shall have been informed of the possibility of such damages. This   *
+*  limitation of liability shall not apply to liability for death or   *
+*  personal injury resulting from such party's negligence to the       *
+*  extent applicable law prohibits such limitation. Some               *
+*  jurisdictions do not allow the exclusion or limitation of           *
+*  incidental or consequential damages, so this exclusion and          *
+*  limitation may not apply to You.                                    *
+*                                                                      *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+  This Source Code Form is "Incompatible With Secondary Licenses", as
+  defined by the Mozilla Public License, v. 2.0.
+

f2_commander-0.1.0/PKG-INFO

@@ -0,0 +1,250 @@
+Metadata-Version: 2.1
+Name: f2-commander
+Version: 0.1.0
+Summary: F2 Commander is an orthodox file manager for the modern world.
+Home-page: https://github.com/candidtim/f2-commander
+License: MPL-2.0
+Keywords: file,manager,commander
+Author: Timur Rubeko
+Author-email: timcandid@gmail.com
+Requires-Python: >=3.10,<4.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: License :: OSI Approved
+Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Desktop Environment :: File Managers
+Requires-Dist: humanize (>=4.10,<5.0)
+Requires-Dist: platformdirs (>=4.2.2,<5.0.0)
+Requires-Dist: python-dotenv (>=1.0.1,<2.0.0)
+Requires-Dist: send2trash (>=1.8.3,<2.0.0)
+Requires-Dist: textual (>=0.76,<1)
+Project-URL: Bug Tracker, https://github.com/candidtim/f2-commander/issues
+Project-URL: Repository, https://github.com/candidtim/f2-commander
+Description-Content-Type: text/markdown
+
+# F2 Commander
+
+F2 Commander is an orthodox file manager for the modern world.
+
+![F2 Commander Demo](img/f2.png "F2 Commander")
+
+## Status
+
+F2 Commander is usable, with a core set of features implemented. While it is
+functional, development is ongoing. See the "Roadmap" below for a complete
+feature list and their status. This is a personal project with all its
+implications. See the "About" section below for more information. Users are
+encouraged to contribute and report issues.
+
+## Installation
+
+From source:
+
+    poetry build
+    pipx install [--force] dist/f2_commander-0.1.0.tar.gz
+
+This software is designed to work in Linux and MacOS. It should also work in
+WSL (Windows Subsystem for Linux).
+
+## Usage
+
+ - Start by running `f2` in your terminal emulator
+ - Hit `?` to see the built-in help
+ - Hit `q` to quit
+
+## Roadmap
+
+F2 Commander mission is to bring the experience of an orthodox file
+manager into the world of modern computing.
+
+F2 Commander main principles are:
+
+ - "file system" can be anything that contains files, blobs, etc.
+ - focus on the **tasks** for file manipulation
+ - discoverability of file systems (making file systems easy to navigate)
+ - discoverability of the tool itself (making it easy and evident to use)
+ - the software should be easy to adapt, shape and extend
+
+Features:
+
+ - User Interface
+
+   - [x] Two-panel interface
+   - [x] Classic footer with common user actions
+     - [ ] Contextual footer (changes actions based on context)
+     - [ ] Configurable key bindings. "Modern" and "Retro" bindings out of the box.
+   - [ ] Menubar
+   - [x] Command Palette
+   - [ ] File Info / Preview panel
+   - [x] Drop to shell (command line) temporarily
+   - [ ] Theming. "Modern" and "Retro" themes out of the box.
+
+ - Configuration
+
+   - [x] User configuration file
+   - [ ] UI for most common configuration options
+     - [ ] Options for user-defined viewer, editor, shell, and default file actions
+     - [ ] Enable/disable CWD following the user selection
+     - [ ] Enable/disable case sensitivity when ordering by name
+     - [ ] List dirs first toggle
+     - [ ] Starting directory for each pane (cwd, home, fixed path, or last location)
+
+ - Navigation
+
+   - [x] Basic file and directory info: entry names, human-readable size,
+         last modification time, show and follow symlinks, etc.
+   - [x] Vim-like (up/down j/k g/G ctrl+f/d/b/u) navigation
+   - [x] Navigate "up" (with backspace or with the ".." entry)
+   - [x] Order entries by name, size, time (last modification time)
+   - [x] Filter entries with glob
+   - [x] Directory summary in the file listing footer
+   - [x] "List dirs first/inline" toggle
+   - [x] Ordering by name case sensitivity on/off
+   - [ ] Quick search: navigate file list by typing in the file names
+   - [ ] Navigate to path (enter path, with auto-completion)
+   - [ ] Bookmarks (set and navigate to the bookmarks)
+   - [x] "Same location" and "Swap panels" actions
+   - [ ] CWD follows user selection
+   - [ ] Detect external changes and update file listing when possible
+   - [x] Open current location in the OS default file manager
+
+ - File and directory manipulation
+
+   - [x] Basic operations like copy, move, move to trash, etc.
+     - [x] Confirmation dialogs and user inputs (destination path, etc.)
+     - [x] Multiple file selection
+     - [ ] Progress bar for long operations
+     - [ ] Option to delete files (as opposed to moving to trash)
+   - [x] View and edit files using user default viewer and editor
+   - [x] "Open" files with a default associated program (e.g., view PDF, etc.)
+   - [ ] Run programs (run executable files)
+   - [x] Create a new directory
+   - [ ] Create a new file
+   - [x] "Show/hide hidden files" toggle
+   - [ ] Create and modify symlinks, show broken, and other symlink tasks
+   - [ ] Compute directory size on selection
+
+ - "File systems" support
+
+   - [x] "Local" OS file system
+   - [ ] AWS S3
+   - [ ] GCP GCS
+   - [ ] Dropbox
+   - [ ] FTP, FTPS, SFTP
+   - [ ] ... show must go on ...
+
+ - Archival and compression support
+
+   - [ ] ZIP (read, create, update)
+   - [ ] ... and more ...
+
+ - Documentation
+
+   - [x] Built-in help
+   - [ ] User manual
+
+ - Windows support. You are probably better off with WSL, but some day, maybe...
+
+   - [ ] Test all features in Windows
+   - [ ] Then, maybe plan fixes
+
+User experience and app behavior:
+
+ - Dialogs
+
+   - [ ] "Do not ask me again" option in "safe" dialogs (e.g., "Quit" dialog)
+   - [ ] Allow "Enter" and "y" keys in "safe" dialogs for confirmation
+
+ - Navigation
+
+   - [x] Save user's choises between restarts (hidden files toggle, dirs first, etc.)
+   - [ ] Consistent cursor positioning
+     - [x] ... on the source directory when navigating "up"
+     - [ ] ... on the source link when navigating back from symlink
+     - [ ] ... on the nearest entry after delete or move
+   - [ ] Clicking on list headers changes ordering in according columns
+
+Known bugs to fix:
+
+ - Restore the "show hidden files" state when switching back to the file list
+   after having used a different panel type.
+
+ - Errors in copy, move, etc. are not handled (e.g., destination directory
+   doesn't exist, etc.). Note that not only preconditions should be checked,
+   but also the errors should be handled (e.g., destination can be deleted
+   during copy, network connection dropped, etc.)
+
+ - ".." path is allowed for selection and can be copied, moved, etc.; handle
+   ".." and empty selections better
+
+ - File info and preview panels show nothing on start unless a selection is
+   changed in the file list.
+
+ - Default viewer, editor, shell and "open" programs are mostly MacOS-specific,
+   choices are too rigid. Make sure defaults work on clean MacOS and Linux
+   installs.
+
+ - File list has an unnecessary 2-column (2 character wide) gap even when no
+   vertical scroll bar is present (2 characters are reserved for the scroll
+   bar)
+
+ - Ctrl+U / Ctrl+D should scroll half a page (not en entire page)
+
+ - Selection is always cleared if "Hidden files" toggle is changed
+
+## Development environment
+
+This project uses Poetry for dependency management and as a build tool. The
+configuration is conventional, use as usual:
+
+    poetry install --with dev
+
+It also uses black, flake8, isort, mypy and pytest. An IDE or an LSP should
+pick up their configuration, or they can be executed with poetry. For example:
+
+    poetry run pytest
+
+To run all code quality controls and linters:
+
+    ./check
+
+To run the application from source code:
+
+    poetry run f2
+
+To run the application with dev tools:
+
+    poetry run textual console [-v -x SYSTEM -x EVENT -x DEBUG -x INFO]  # this first!
+    poetry run textual run --dev f2.app:F2Commander
+
+## About
+
+"F2" is a loose interpretation of "a **F**ile manager with **2** side-by-side
+panels", and "Commander" is an homage to the old-school orthodox file managers.
+
+"F2 Commander" is a personal project that has grown into a full-fledged file
+manager and is now open-sourced. Being a personal project means that: a) my
+intent is to follow the "Roadmap" outlined above, but development and bug fixing
+may be irregularly-paced and priorities may shift; b) the intent is to keep it
+stable, yet future versions may include backward-incompatible changes where that
+would seem practical to do.
+
+## Contributions
+
+Bug reports, feature requests and pull requests are welcome.
+
+If you plan to contirbute to the source code, see the "Development environment"
+above, and make sure to run the linters.
+
+## License
+
+This application is provided "as is", without warranty of any kind.
+
+Mozilla Public License, v. 2.0.
+