korhner / cookiecutter-sqldoc-plugin

============================ Cookiecutter sqldoc Plugin

Minimal Cookiecutter template for authoring sqldoc plugins that help you to write better programs.

This template requires Cookiecutter 1.4.0 "Shortbread" or higher

Getting Started

Simply install Cookiecutter and generate a new sqldoc plugin project:

$ pip install cookiecutter
$ cookiecutter https://github.com/korhner/cookiecutter-sqldoc-plugin

Cookiecutter prompts you for information regarding your plugin:

full_name [Ivan Korhner]: Ivan Korhner
email [[e-mail]]: [e-mail]
github_username [korhner]: korhner
plugin_name [sqldoc]: sqldoc
short_description [A simple plugin to use with sqldoc]:
version [0.1.0]:
sqldoc_version [0.1.0]:
Select docs_tool:
1 - mkdocs
2 - sphinx
3 - none
Choose from 1, 2, 3 [1]: 1
Select license:
1 - MIT
2 - BSD-3
3 - GNU GPL v3.0
Choose from 1, 2, 3 [1]: 2
INFO:post_gen_project:Moving files for mkdocs.

There you go - you just created a minimal sqldoc plugin:

sqldoc-plugin/
├── LICENSE
├── README.rst
├── docs
│   └── index.md
├── mkdocs.yml
├── sqldoc_plugin.py
├── setup.py
├── tests
│   ├── conftest.py
│   └── test_plugin.py
└── tox.ini

Features

• Installable PyPI package featuring a setup.py.
• Test suite running Tox and sqldoc that makes sure your plugin is working as expected
• Comprehensive README.rst file that contains useful information about your plugin
• Continuous integration configuration for Travis CI and AppVeyor
• Optional documentation with either Sphinx or MkDocs
• Choose from several licenses, such as MIT, BSD-3, Apache v2.0, GNU GPL v3.0, or MPL v2.0

Contribute

We welcome you to contribute to this project. Please visit the documentation to get started!

Issues

If you encounter any problems, please file an issue along with a detailed description.

Code of Conduct

Everyone interacting in the Cookiecutter sqldoc Plugin project's codebases, issue trackers is expected to follow the PyPA Code of Conduct.

License

Distributed under the terms of the MIT license, Cookiecutter sqldoc Plugin is free and open source software