Merge branch 'develop' into 'master'

Develop

See merge request rchaput/xdgprefs!10

.gitignore

@@ -0,0 +1,7 @@
+# IntelliJ project files
+.idea
+
+**/.cache
+build/**
+dist/**
+XDG_Prefs.egg-info/**

CONTRIBUTING

@@ -0,0 +1,15 @@
+Since this project is open-source, you are welcome to contribute.
+
+This project uses multiple git branches:
+* feature branches are used to add enhancements to the project. They must
+be named after the issue they're referring (e.g. issue XP-003 is targeted in
+feature branch XP-003). They are later merged into develop when the feature
+is finished.
+* develop branch is the core branch. It is used to group all done features. It
+can occasionally contain hotfixes.
+* release branches are created each time a new release is started. They are
+merged from develop when all planned features are ready. They can also
+contain specific release fixes (e.g. change of configuration, version
+number)
+* master branch is merged from release branches (a tag must be added each
+time a release is pulled)

LICENSE

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

README.md

@@ -1,3 +1,124 @@
-# xdg-prefs
+# XDG-Prefs
+> Remy Chaput <[email protected]>
 
-Program that allows you to change the default application on your Linux system, using XDG standard.
+On GNU/Linux systems, each file has an associated MIME Type (or Media Type)
+that represents the kind of content (for example, *image/jpeg*).
+Your system uses a database to list your preferences for default applications
+(for example, to use *eog* as default application for *image/jpeg*).
+
+*XDG-Prefs* uses the [XDG Specifications][xdg-spec] to read and modify this
+database, allowing you to change your preferred default applications for
+each MIME type. The [XDG Specifications][xdg-spec] is the reference 
+specification for MIME types and default applications, meaning that the
+preferences you will set in *XDG-Prefs* will be recognized by all other
+XDG-compliant softwares (such as `xdg-open`, which is typically used when
+you double-click on a file).
+
+Usually, Desktop Environments (such as *Gnome*, or *KDE*) provide some kind of
+tool to manage these preferences ; this software works on every Window Manager
+(including those that are not Desktop Environments, such as *i3wm*).
+
+*Note*: *XDG-Prefs* is not associated with the 
+[Freedesktop Organization][freedesktop], and is not an official software of the 
+[XDG Specifications][xdg-spec]. 
+
+## Getting started
+
+Download the Wheel (.whl) file in the [releases] section and install it using
+`pip install XDG_Prefs-<version>-py3-none-any.whl` (replace `<version>` with
+the number of the version you downloaded, such as `0.1`: 
+`XDG_Prefs-0.1-py3-none-any.whl`).
+Please note that you must use Python3.5 or later (you might need to replace
+`pip` with `pip3` on some distributions, such as Debian).
+
+Alternatively, you can clone this project on your computer and run
+ `python setup.py install`. This is recommended if you want to contribute.
+Again, you will need to use Python3.5 or later (you might need to replace
+`python` with `python3` on some distributions, such as Debian).
+
+This will install the required files and create a `xdg-prefs` executable.
+
+## How to use
+
+Launch `xdg-prefs` (for example from the command line). On the interface you
+will see 3 panels (each associated to a tab):
+1. **Associations**: allows you to see the current default application for each
+MIME Type.
+Simply click on the list, on the left of a given MIME Type to see the list
+of possible applications. Click on one of them to set it as the default
+application.
+2. **List MIME Types**: allows you to see the list of known MIME types on your
+computer, and to search for specifics MIME types. Even MIME types which do
+not have an associated default application are listed here.
+3. **List Applications**: allows you to see the list of known applications on
+your computer (that is, those with a *.desktop* file). You can see the list
+of MIME types each application is able to handle, and a description of the
+application.
+
+*XDG-Prefs* will print logs on the bottom of the interface, especially when
+you set a new default application.
+
+## Features
+
+* Python implementation of multiples XDG Specifications.  
+Directly reads the files that compose each of the following databases:
+  * [Shared MIME Database][mime-spec] (list of all MIME types)
+  * [Desktop Entry][apps-spec] (list of applications)
+  * [MIME Applications Associations][xdg-spec] (preferences for default
+  applications)
+* Qt5 interface
+  * allows to see and filter list of MIME types
+  * allows to see and filter list of applications
+  * allows to see and change the default application associated to each MIME type
+* Works with every window manager
+
+## Dependencies
+
+This project only depends on
+* Python3.5 (should work with later versions)
+* PySide2 (Qt5 for Python ; tested with version 5.9.0a1)
+* configparser (Python standard library to read config files)
+* [future_fstrings](https://pypi.org/project/future-fstrings/) 
+(in order to use PEP498's F-strings in Python3.5)
+* Uses code from https://github.com/wor/desktop_file_parser
+(in order to parse [Desktop files][apps-spec])
+
+## Contributing
+
+This is an Open-Source projects, your contributions are very welcome.
+
+If you have an idea for a new feature, an optimization or if you notice a bug,
+feel free to [open an issue][issues].
+
+You are also welcome to contribute to the code directly, in this case please
+refer to the [Contributing guidelines][contrib].
+
+## Related projects
+
+Here's a list of other projects related to the [XDG Specifications][xdg-spec]
+and/or the setting of default applications on GNU/Linux:
+
+* [PyXDG](https://www.freedesktop.org/wiki/Software/pyxdg/)
+* [xdg-utils](https://www.freedesktop.org/wiki/Software/xdg-utils/), including:
+  * [xdg-mime](http://portland.freedesktop.org/doc/xdg-mime.html)
+  * [xdg-open](http://portland.freedesktop.org/doc/xdg-open.html)
+* gnome-default-applications-properties
+
+## Licensing
+
+This project is licensed under the [Apache License][license].
+
+Basically, this means that you are allowed to modify and distribute this
+project, but you must include the [License][license] file and state the
+changes you've made (please refer to the [License][license] file or the
+https://choosealicense.com/licenses/apache-2.0/ website for the full
+list of permissions, conditions and limitations).
+
+[issues]:issues/new
+[releases]:releases/
+[xdg-spec]:https://www.freedesktop.org/wiki/Specifications/mime-apps-spec/
+[freedesktop]:https://www.freedesktop.org/wiki/
+[mime-spec]:https://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec/
+[apps-spec]:https://www.freedesktop.org/wiki/Specifications/desktop-entry-spec/
+[contrib]:./CONTRIBUTING
+[license]:./LICENSE

requirements.txt

@@ -0,0 +1,2 @@
+pyside2
+future_fstrings

setup.py

@@ -0,0 +1,44 @@
+import os
+from setuptools import setup
+
+
+def read(fname):
+    return open(os.path.join(os.path.dirname(__file__), fname)).read()
+
+
+setup(
+    name='XDG-Prefs',
+    version='0.1',
+
+    packages=['xdgprefs', 'xdgprefs.core', 'xdgprefs.gui'],
+    install_requires=['PySide2', 'future-fstrings'],
+
+    entry_points={
+        'gui_scripts': [
+            'xdg-prefs = xdgprefs.__main__:main'
+        ]
+    },
+
+
+    author='Remy Chaput',
+    author_email='[email protected]',
+    description='A GUI program to view and change your default programs\' '
+                'preferences (which program should open which type of file), '
+                'using the XDG Specifications',
+    long_description=read('README.md'),
+    long_description_content_type='text/markdown',
+
+    license='Apache',
+    keywords='GUI MIME preferences XDG',
+    platforms=['GNU/Linux'],
+    classifiers=[
+        'Development Status :: 4 - Beta',
+        'Environment :: X11 Applications',
+        'Intended Audience :: End Users/Desktop',
+        'License :: OSI Approved :: Apache Software License',
+        'Natural Language :: English',
+        'Operating System :: Unix',
+        'Programming Language :: Python :: 3.5',
+        'Topic :: Utilities'
+    ]
+)

xdgprefs/__init__.py

@@ -0,0 +1,2 @@
+from . import core
+from . import gui