Metadata-Version: 1.1
Name: subfiles
Version: 1.0.4
Summary: A command line program to generate list of file subextensions.
Home-page: https://github.com/mindey/subfiles
Author: Mindey
Author-email: mindey@qq.com
License: UNLICENSE
Description: .. image:: https://raw.githubusercontent.com/mindey/subfiles/master/misc/subfiles.png
            :alt: Subfiles Illustration
            :width: 100%
            :align: center
        
        The package introduces a command ``subtypes`` (≠ ``subfiles``) to extract **subtypes of files** in a directory, so as to have a list of file extensions appearing in directory for any purpose.
        
        The idea here is that our file extensions don't have to end with one dot, and we can create multi-level namespaces for file extensions for all kind of uses based on dot notation. There are many potential uses. For example, you might want to use secondary level extensions represent and map files with schemas of data instances that they contain. So, ``.subtypes`` is supposed to just contain any metadata that file extensions carry beyond what the file extension represents. For example, it could be a specific format of the CSV, or anything whatsoever, that helps any other programs or humanst to understand the files in project, such as:
        
        Purpose
        -------
        
        Extracts subtypes of files in a directory, so as to have a list of file extensions appearing in directory.
        
        Usage
        -----
        
        Set up::
        
            $ pip install subfiles
        
        In any project, or directory, run::
        
            $ subtypes -l
        
        This will output files grouped by different file sub-extensions in the project.
        
        To start defining schemas for files with some filetypes, do::
        
            $ subtypes -l > .subtypes
        
        Then, edit the generated ``.subtypes`` file to suit your needs, in the following format:
        
        .. code::
        
           [.city.csv] - SHORT DESCRIPTION
           MORE INFORMATION
        
           [.observation.json] - SHORT DESCRIPTION
           MORE INFORMATION
        
        Example
        -------
        
        .. code::
        
           [.graph.json] - https://www.wikidata.org/wiki/Q182598
           cat: https://www.wikidata.org/wiki/Q146
           dog: https://www.wikidata.org/wiki/Q144
           love: https://www.wikidata.org/wiki/Q316
           
           [.products.csv] - https://www.wikidata.org/wiki/Q278425
           url: https://www.wikidata.org/wiki/Q42253
           currency: https://www.wikidata.org/wiki/Q8142
           price: https://www.wikidata.org/wiki/Q160151
           name: https://www.wikidata.org/wiki/Q1786779
        
        Development reminder
        ====================
        
        To publish new version on PyPI::
        
            $ python setup.py sdist bdist_wheel
            $ twine upload dist/*
        
Keywords: cli
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Topic :: Utilities
Classifier: License :: Public Domain
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
