Metadata-Version: 1.2
Name: do-pack
Version: 0.1.4
Summary: A command-line tool to create python packages
Home-page: https://github.com/wilfredinni/do-pack
Author: Carlos Montecinos Geisse
Author-email: carlos.w.montecinos@gmail.com
License: MIT License
Description-Content-Type: UNKNOWN
Description: do-pack
        =======
        
        A simple and quick command line tool to create python packages.
        
        .. image:: https://badge.fury.io/py/do-pack.svg
            :target: https://badge.fury.io/py/do-pack
        
        .. image:: https://travis-ci.org/wilfredinni/do-pack.svg?branch=master
            :target: https://travis-ci.org/wilfredinni/do-pack
        
        .. image:: https://requires.io/github/wilfredinni/do-pack/requirements.svg?branch=master
            :target: https://requires.io/github/wilfredinni/do-pack/requirements/?branch=master  
            
        .. image:: https://api.codacy.com/project/badge/Grade/33ea81ba45c64d1199f8b9cd94f11131
            :target: https://www.codacy.com/app/carlos.w.montecinos/do-pack?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=wilfredinni/do-pack&amp;utm_campaign=Badge_Grade
        
        .. image:: https://bettercodehub.com/edge/badge/wilfredinni/do-pack?branch=master
            :target: https://bettercodehub.com/
        
        .. image:: http://img.shields.io/badge/license-MIT-green.svg
            :target: https://github.com/wilfredinni/do-pack/blob/master/LICENSE
        
        Install
        -------
        
        ``$ pip install do-pack``
        
        Usage
        -----
        
        The config command
        ~~~~~~~~~~~~~~~~~~
        
        ``$ do config``
        
        Use it to fill common fields once (if executed twice it
        will overwrite the previous configuration).
        
        Create a default python project
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        ``$ do create <project-name>``
        
        Create a project using one of the available templates
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        ``$ do create <project-name> -t <template>``
        
        *-t* is the short for *--template*.
        
        Available templates:
        
        -  *flask*
        -  *django*
        -  *pymin* (minimal python project)
        
        To use your own template you need to store it in a *.json* file in your current
        directory, e.g.:
        
        ``my_template.json``
        
        And use it by:
        
        ``$ do create my_project -t my_template``
        
        A step by step setup for new projects
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        ``$ do assistant``
        
        This command help you fill:
        
        -  ``setup.py``
        -  ``AUTHORS.rst``
        -  ``LICENSE``
        -  ``.gitignore`` with rules for *Linux*, *MacOs*,
           *Windows*, *Python*, *Visual Studio*, *VS Code*, *Sublime Text* and
           *Pycharm* (made with https://www.gitignore.io/).
        
        Default Folder Structure and Templates
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        This is the folder structure created when using
        ``do create <my_project>`` and ``do assistant``.
        
        ::
        
            project_folder
            â”œâ”€â”€ project
            â”‚   â”œâ”€â”€ __init__.py
            â”‚   â””â”€â”€ project.py
            â”œâ”€â”€ docs
            â”‚   â””â”€â”€ index.rst
            â”œâ”€â”€ tests
            â”‚   â”œâ”€â”€ __init__.py
            â”‚   â””â”€â”€ project_test.py
            â”œâ”€â”€ .gitignore
            â”œâ”€â”€ LICENSE
            â”œâ”€â”€ README.rst
            â”œâ”€â”€ AUTHORS.rst
            â”œâ”€â”€ setup.py
            â”œâ”€â”€ requirements.txt
            â””â”€â”€ test-requirements.txt
        
        -  The template system use a ``.json`` file in wich the keys are
           folders and the values are files.
        -  Every time a folder is created, the program will automatically enter
           it. If you need to exit that folder so the next one is placed in the
           same directory, place a ``<--`` in the files (values) as many times needed.
        -  Folders (keys) ``base`` and ``bin`` are replaced with the project name.
        -  ``project.py`` is replaced with the project name (e.g.
           ``my_project.py``).
        -  In ``test_projet.py``, ``project`` is replaced with the project name
           (e.g. ``test_my_project.py``)
        
        This is the template for the default folder structure:
        
        ::
        
            {
                "base": [
                    "LICENSE",
                    "setup.py",
                    "README.rst",
                    "AUTHORS.rst",
                    ".gitignore",
                    "requirements.txt",
                    "test-requirements.txt",
                    "MANIFEST.in"
                ],
                "bin": [
                    "project.py",
                    "__init__.py",
                    "<--"
                ],
                "docs": [
                    "index.rst",
                    "<--"
                ],
                "tests": [
                    "__init__.py",
                    "test_project.py",
                    "<--"
                ]
            }
        
        TODOs
        ~~~~~
        
        -  Implement ``--template`` for  the ``assistant`` command (75%).
        -  Add github username to the ``config`` command for the project
           url.
        -  Generate the documentation (sphinx).
        
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Requires-Python: >=3
