Metadata-Version: 2.1
Name: qwikstart
Version: 0.4.0
Summary: Code generator for automating configuration, setup, and yak shaving.
Home-page: https://github.com/tonysyu/qwikstart
License: BSD-3-Clause
Keywords: console,terminal
Author: Tony S. Yu
Author-email: tsyu80@gmail.com
Requires-Python: >=3.6,<4.0
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Software Development
Provides-Extra: docs
Requires-Dist: binaryornot (>=0.4.4,<0.5.0)
Requires-Dist: click (>=7.0,<8.0)
Requires-Dist: colorlog (>=4.0.2,<5.0.0)
Requires-Dist: dataclasses (>=0.7,<0.8); python_version >= "3.6" and python_version < "3.7"
Requires-Dist: gitpython (>=3.0.5,<4.0.0)
Requires-Dist: jinja2 (>=2.10,<3.0)
Requires-Dist: prompt-toolkit (>=3.0.3,<4.0.0)
Requires-Dist: pyyaml (>=5.1,<6.0)
Requires-Dist: rope (>=0.14.0,<0.15.0)
Requires-Dist: sphinx (<2); extra == "docs"
Requires-Dist: sphinx-autobuild; extra == "docs"
Requires-Dist: sphinxcontrib-napoleon; extra == "docs"
Requires-Dist: termcolor (>=1.1.0,<2.0.0)
Requires-Dist: typing-extensions (>=3.7,<4.0)
Project-URL: Documentation, https://qwikstart.readthedocs.io/
Project-URL: Repository, https://github.com/tonysyu/qwikstart
Description-Content-Type: text/x-rst

qwikstart: Code injector for fun and profit
===========================================

.. default-role:: literal

.. image:: https://img.shields.io/badge/License-BSD%203--Clause-blue.svg
   :target: https://github.com/tonysyu/qwikstart/blob/master/LICENSE

.. image:: https://travis-ci.com/tonysyu/qwikstart.svg?branch=master
   :target: https://travis-ci.com/tonysyu/qwikstart

.. image:: https://codecov.io/gh/tonysyu/qwikstart/branch/master/graph/badge.svg
   :target: https://codecov.io/gh/tonysyu/qwikstart

.. image:: https://readthedocs.org/projects/qwikstart/badge/
   :target: https://qwikstart.readthedocs.io


- **Documentation:** https://qwikstart.readthedocs.io
- **Source:** https://github.com/tonysyu/qwikstart

Install
=======

The recommended way of installing `qwikstart` is to use pipx_::

    pipx install qwikstart

If you happen to be setting up pipx_ for the first time, the
`pipx installation instructions`_ suggest running `pipx ensurepath` to update
the user path. Note, if you use `~/.profile` instead of `~/.bash_profile`,
this will add `~/.bash_profile`, which will take precendence over `~/.profile`.
Either move the code from `~/.bash_profile` to `~/.profile` or
`link your profiles <https://superuser.com/a/789465>`_.

.. _pipx: https://pypi.org/project/pipx/
.. _pipx installation instructions:
    https://pipxproject.github.io/pipx/installation/

Basic Usage
===========

After installing `qwikstart`, you can run a simple hello-world example using the following::

    qwikstart run --repo https://github.com/tonysyu/qwikstart examples/hello_world.yml

By default, there are abbreviations for common git repos, so the above can also be written::

    qwikstart run --repo gh:tonysyu/qwikstart examples/hello_world.yml


See Also
========

- `hygen <https://www.hygen.io/>`_: The scalable code generator that saves you
  time.
- `cookiecutter <https://cookiecutter.readthedocs.io/>`_:
  A command-line utility that creates projects from cookiecutters (project
  templates)
- `pyscaffold <https://pyscaffold.org/>`_: Python project template generator
  with batteries included.

