A utility to generate common git repository files, Readmes,Licenses,..etc.
Project description
docrepo.
Automate the Boring Stuff of Creating Common Git Repo Files using some universal templates. This tool will generate:
- A template README.md that you can customize and edit to suit your needs
- A template CONTRIBUTING guideline
- A PULL_REQUEST_TEMPLATE
- A template CODE_OF_CONDUCT.md
- A bug_report ISSUE_TEMPLATE
- A feature_request ISSUE_TEMPLATE
- A sample gitignore with common entries
This might come in handy to ensure your project meets the common community guidelines and save you your most valuable resource which is time. And as the adage goes Time is Money so save some Money. :heavy_dollar_sign:
Installation
This package is available on pypi you can install it using pip :100:
pip install initgitdoc
Usage
After pip install you can invoke the command line for help
mkdir <A-Folder-Name>
cd <A-Folder-Name>
git init .
git remote add origin \
https://github.com/<Your-Github-User-Name>/<Your-Github-Repository-Name>.git
initgitdoc --help
initgitdoc -n <Your-Github-Repository-Name> -a <Your-Github-User-Name>
ls
Development
git clone https://github.com/TralahM/docrepo.git
cd docrepo
python setup.py bdist_wheel
python -m pip install dist/initgitdoc-0.1-py3-none-any.whl
Scripts Herein.
Contributors.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
initgitdoc-0.2-py3-none-any.whl
(10.7 kB
view hashes)